@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,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
+ 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 = "CustomFieldValueProto";
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 value for a CustomField on a resource.
31
+ message CustomFieldValue {
32
+ // Represent custom field value type.
33
+ // Next Id: 5
34
+ message Value {
35
+ // The value of this field.
36
+ oneof value {
37
+ // The custom_field_option_id, if the CustomFieldDataType is DROPDOWN.
38
+ int64 dropdown_value = 1;
39
+
40
+ // The value, if the CustomFieldDataType is STRING.
41
+ string string_value = 2;
42
+
43
+ // The value, if the CustomFieldDataType is NUMBER.
44
+ double number_value = 3;
45
+
46
+ // The value, if the CustomFieldDataType is TOGGLE.
47
+ bool toggle_value = 4;
48
+ }
49
+ }
50
+
51
+ // Required. The custom field for which this is a value.
52
+ // Format: "networks/{network_code}/customFields/{custom_field_id}"
53
+ string custom_field = 1 [
54
+ (google.api.field_behavior) = REQUIRED,
55
+ (google.api.resource_reference) = {
56
+ type: "admanager.googleapis.com/CustomField"
57
+ }
58
+ ];
59
+
60
+ // Required. A typed value representation of the value.
61
+ optional Value value = 2 [(google.api.field_behavior) = REQUIRED];
62
+ }
@@ -0,0 +1,76 @@
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 = "CustomTargetingKeyEnumsProto";
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
+ // [CustomTargetingKeyStatus][google.ads.admanager.v1.CustomTargetingKeyStatusEnum.CustomTargetingKeyStatus]
29
+ message CustomTargetingKeyStatusEnum {
30
+ // Status of the custom targeting key.
31
+ enum CustomTargetingKeyStatus {
32
+ // Not specified value.
33
+ CUSTOM_TARGETING_KEY_STATUS_UNSPECIFIED = 0;
34
+
35
+ // Custom targeting key is active.
36
+ ACTIVE = 1;
37
+
38
+ // Custom targeting key is inactive.
39
+ INACTIVE = 2;
40
+ }
41
+ }
42
+
43
+ // Wrapper message for
44
+ // [CustomTargetingKeyType][google.ads.admanager.v1.CustomTargetingKeyTypeEnum.CustomTargetingKeyType]
45
+ message CustomTargetingKeyTypeEnum {
46
+ // Type of the custom targeting key.
47
+ enum CustomTargetingKeyType {
48
+ // Not specified value.
49
+ CUSTOM_TARGETING_KEY_TYPE_UNSPECIFIED = 0;
50
+
51
+ // Key with a fixed set of values.
52
+ PREDEFINED = 1;
53
+
54
+ // Key without a fixed set of values
55
+ FREEFORM = 2;
56
+ }
57
+ }
58
+
59
+ // Wrapper message for
60
+ // [CustomTargetingKeyReportableType][google.ads.admanager.v1.CustomTargetingKeyReportableTypeEnum.CustomTargetingKeyReportableType]
61
+ message CustomTargetingKeyReportableTypeEnum {
62
+ // Reportable type of the custom targeting key.
63
+ enum CustomTargetingKeyReportableType {
64
+ // Not specified value.
65
+ CUSTOM_TARGETING_KEY_REPORTABLE_TYPE_UNSPECIFIED = 0;
66
+
67
+ // Not available for reporting in the Ad Manager query tool.
68
+ OFF = 1;
69
+
70
+ // Available for reporting in the Ad Manager query tool.
71
+ ON = 2;
72
+
73
+ // Custom dimension available for reporting in the AdManager query tool.
74
+ CUSTOM_DIMENSION = 3;
75
+ }
76
+ }
@@ -0,0 +1,69 @@
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/custom_targeting_key_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 = "CustomTargetingKeyMessagesProto";
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 `CustomTargetingKey` resource.
32
+ message CustomTargetingKey {
33
+ option (google.api.resource) = {
34
+ type: "admanager.googleapis.com/CustomTargetingKey"
35
+ pattern: "networks/{network_code}/customTargetingKeys/{custom_targeting_key}"
36
+ plural: "customTargetingKeys"
37
+ singular: "customTargetingKey"
38
+ };
39
+
40
+ // Identifier. The resource name of the `CustomTargetingKey`.
41
+ // Format:
42
+ // `networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}`
43
+ string name = 1 [(google.api.field_behavior) = IDENTIFIER];
44
+
45
+ // Output only. `CustomTargetingKey` ID.
46
+ int64 custom_targeting_key_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
47
+
48
+ // Immutable. Name of the key. Keys can contain up to 10 characters each. You
49
+ // can use alphanumeric characters and symbols other than the following:
50
+ // ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ], the white space character.
51
+ string ad_tag_name = 3 [(google.api.field_behavior) = IMMUTABLE];
52
+
53
+ // Optional. Descriptive name for the `CustomTargetingKey`.
54
+ string display_name = 4 [(google.api.field_behavior) = OPTIONAL];
55
+
56
+ // Required. Indicates whether users will select from predefined values or
57
+ // create new targeting values, while specifying targeting criteria for a line
58
+ // item.
59
+ CustomTargetingKeyTypeEnum.CustomTargetingKeyType type = 5
60
+ [(google.api.field_behavior) = REQUIRED];
61
+
62
+ // Output only. Status of the `CustomTargetingKey`.
63
+ CustomTargetingKeyStatusEnum.CustomTargetingKeyStatus status = 6
64
+ [(google.api.field_behavior) = OUTPUT_ONLY];
65
+
66
+ // Required. Reportable state of the `CustomTargetingKey`.
67
+ CustomTargetingKeyReportableTypeEnum.CustomTargetingKeyReportableType
68
+ reportable_type = 7 [(google.api.field_behavior) = REQUIRED];
69
+ }
@@ -0,0 +1,129 @@
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/custom_targeting_key_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 = "CustomTargetingKeyServiceProto";
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 `CustomTargetingKey` objects.
34
+ service CustomTargetingKeyService {
35
+ option (google.api.default_host) = "admanager.googleapis.com";
36
+
37
+ // API to retrieve a `CustomTargetingKey` object.
38
+ rpc GetCustomTargetingKey(GetCustomTargetingKeyRequest)
39
+ returns (CustomTargetingKey) {
40
+ option (google.api.http) = {
41
+ get: "/v1/{name=networks/*/customTargetingKeys/*}"
42
+ };
43
+ option (google.api.method_signature) = "name";
44
+ }
45
+
46
+ // API to retrieve a list of `CustomTargetingKey` objects.
47
+ rpc ListCustomTargetingKeys(ListCustomTargetingKeysRequest)
48
+ returns (ListCustomTargetingKeysResponse) {
49
+ option (google.api.http) = {
50
+ get: "/v1/{parent=networks/*}/customTargetingKeys"
51
+ };
52
+ option (google.api.method_signature) = "parent";
53
+ }
54
+ }
55
+
56
+ // Request object for `GetCustomTargetingKey` method.
57
+ message GetCustomTargetingKeyRequest {
58
+ // Required. The resource name of the CustomTargetingKey.
59
+ // Format:
60
+ // `networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}`
61
+ string name = 1 [
62
+ (google.api.field_behavior) = REQUIRED,
63
+ (google.api.resource_reference) = {
64
+ type: "admanager.googleapis.com/CustomTargetingKey"
65
+ }
66
+ ];
67
+ }
68
+
69
+ // Request object for `ListCustomTargetingKeys` method.
70
+ message ListCustomTargetingKeysRequest {
71
+ // Required. The parent, which owns this collection of CustomTargetingKeys.
72
+ // Format: `networks/{network_code}`
73
+ string parent = 1 [
74
+ (google.api.field_behavior) = REQUIRED,
75
+ (google.api.resource_reference) = {
76
+ type: "admanager.googleapis.com/Network"
77
+ }
78
+ ];
79
+
80
+ // Optional. The maximum number of `CustomTargetingKeys` to return. The
81
+ // service may return fewer than this value. If unspecified, at most 50
82
+ // `CustomTargetingKeys` will be returned. The maximum value is 1000; values
83
+ // above 1000 will be coerced to 1000.
84
+ int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
85
+
86
+ // Optional. A page token, received from a previous `ListCustomTargetingKeys`
87
+ // call. Provide this to retrieve the subsequent page.
88
+ //
89
+ // When paginating, all other parameters provided to `ListCustomTargetingKeys`
90
+ // must match the call that provided the page token.
91
+ string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
92
+
93
+ // Optional. Expression to filter the response.
94
+ // See syntax details at
95
+ // https://developers.google.com/ad-manager/api/beta/filters
96
+ string filter = 4 [(google.api.field_behavior) = OPTIONAL];
97
+
98
+ // Optional. Expression to specify sorting order.
99
+ // See syntax details at
100
+ // https://developers.google.com/ad-manager/api/beta/filters#order
101
+ string order_by = 5 [(google.api.field_behavior) = OPTIONAL];
102
+
103
+ // Optional. Number of individual resources to skip while paginating.
104
+ int32 skip = 6 [(google.api.field_behavior) = OPTIONAL];
105
+ }
106
+
107
+ // Response object for `ListCustomTargetingKeysRequest` containing matching
108
+ // `CustomTargetingKey` objects.
109
+ message ListCustomTargetingKeysResponse {
110
+ // The `CustomTargetingKey` objects from the specified network.
111
+ repeated CustomTargetingKey custom_targeting_keys = 1;
112
+
113
+ // A token, which can be sent as `page_token` to retrieve the next page.
114
+ // If this field is omitted, there are no subsequent pages.
115
+ string next_page_token = 2;
116
+
117
+ // Total number of `CustomTargetingKey` objects.
118
+ // If a filter was included in the request, this reflects the total number
119
+ // after the filtering is applied.
120
+ //
121
+ // `total_size` will not be calculated in the response unless it has been
122
+ // included in a response field mask. The response field mask can be provided
123
+ // to the method by using the URL parameter `$fields` or `fields`, or by using
124
+ // the HTTP/gRPC header `X-Goog-FieldMask`.
125
+ //
126
+ // For more information, see
127
+ // https://developers.google.com/ad-manager/api/beta/field-masks
128
+ int32 total_size = 3;
129
+ }
@@ -0,0 +1,90 @@
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 = "CustomTargetingValueEnumsProto";
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
+ // [CustomTargetingValueStatus][google.ads.admanager.v1.CustomTargetingValueStatusEnum.CustomTargetingValueStatus]
29
+ message CustomTargetingValueStatusEnum {
30
+ // Status of the custom targeting value.
31
+ enum CustomTargetingValueStatus {
32
+ // Not specified value.
33
+ CUSTOM_TARGETING_VALUE_STATUS_UNSPECIFIED = 0;
34
+
35
+ // Custom targeting value is active.
36
+ ACTIVE = 1;
37
+
38
+ // Custom targeting value is inactive.
39
+ INACTIVE = 2;
40
+ }
41
+ }
42
+
43
+ // Wrapper message for
44
+ // [CustomTargetingValueMatchType][google.ads.admanager.v1.CustomTargetingValueMatchTypeEnum.CustomTargetingValueMatchType]
45
+ message CustomTargetingValueMatchTypeEnum {
46
+ // Match type of the custom targeting value.
47
+ enum CustomTargetingValueMatchType {
48
+ // Not specified value.
49
+ CUSTOM_TARGETING_VALUE_MATCH_TYPE_UNSPECIFIED = 0;
50
+
51
+ // Used for exact matching. For example, the targeting value car=honda will
52
+ // only match to the ad request car=honda.
53
+ EXACT = 1;
54
+
55
+ // Used for lenient matching when at least one of the words in the ad
56
+ // request matches the targeted value. The targeting value car=honda will
57
+ // match to ad requests containing the word honda. So ad requests car=honda
58
+ // or car=honda civic or car=buy honda or car=how much does a honda cost
59
+ // will all have the line item delivered.
60
+ // This match type can not be used within an audience segment rule.
61
+ BROAD = 2;
62
+
63
+ // Used for 'starts with' matching when the first few characters in the ad
64
+ // request match all of the characters in the targeted value. The targeting
65
+ // value car=honda will match to ad requests car=honda or car=hondas for
66
+ // sale but not to car=I want a honda.
67
+ PREFIX = 3;
68
+
69
+ // This is a combination of MatchType#BROAD and MatchType#PREFIX matching.
70
+ // The targeting value car=honda will match to ad requests that contain
71
+ // words that start with the characters in the targeted value, for example
72
+ // with car=civic hondas.
73
+ // This match type can not be used within an audience segment rule.
74
+ BROAD_PREFIX = 4;
75
+
76
+ // Used for 'ends with' matching when the last characters in the ad request
77
+ // match all of the characters in the targeted value. The targeting value
78
+ // car=honda will match with ad requests car=honda or car=I want a honda but
79
+ // not to car=hondas for sale.
80
+ // This match type can not be used within line item targeting.
81
+ SUFFIX = 5;
82
+
83
+ // Used for 'within' matching when the string in the ad request contains the
84
+ // string in the targeted value. The targeting value car=honda will match
85
+ // with ad requests car=honda, car=I want a honda, and also with car=hondas
86
+ // for sale, but not with car=misspelled hond a. This match type can not be
87
+ // used within line item targeting.
88
+ CONTAINS = 6;
89
+ }
90
+ }
@@ -0,0 +1,66 @@
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/custom_targeting_value_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 = "CustomTargetingValueMessagesProto";
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 `CustomTargetingValue` resource.
32
+ message CustomTargetingValue {
33
+ option (google.api.resource) = {
34
+ type: "admanager.googleapis.com/CustomTargetingValue"
35
+ pattern: "networks/{network_code}/customTargetingKeys/{custom_targeting_key}/customTargetingValues/{custom_targeting_value}"
36
+ plural: "customTargetingValues"
37
+ singular: "customTargetingValue"
38
+ };
39
+
40
+ // Identifier. The resource name of the `CustomTargetingValue`.
41
+ // Format:
42
+ // `networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}/customTargetingValues/{custom_targeting_value_id}`
43
+ string name = 1 [(google.api.field_behavior) = IDENTIFIER];
44
+
45
+ // Immutable. Name of the `CustomTargetingValue`. Values can contain up to 40
46
+ // characters each. You can use alphanumeric characters and symbols other than
47
+ // the following: ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ]. Values are
48
+ // not data-specific; all values are treated as strings. For example, instead
49
+ // of using "age>=18 AND <=34", try "18-34"
50
+ string ad_tag_name = 4 [(google.api.field_behavior) = IMMUTABLE];
51
+
52
+ // Optional. Descriptive name for the `CustomTargetingValue`.
53
+ string display_name = 5 [(google.api.field_behavior) = OPTIONAL];
54
+
55
+ // Required. Immutable. The way in which the CustomTargetingValue.name strings
56
+ // will be matched.
57
+ CustomTargetingValueMatchTypeEnum.CustomTargetingValueMatchType match_type = 6
58
+ [
59
+ (google.api.field_behavior) = IMMUTABLE,
60
+ (google.api.field_behavior) = REQUIRED
61
+ ];
62
+
63
+ // Output only. Status of the `CustomTargetingValue`.
64
+ CustomTargetingValueStatusEnum.CustomTargetingValueStatus status = 7
65
+ [(google.api.field_behavior) = OUTPUT_ONLY];
66
+ }
@@ -0,0 +1,132 @@
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/custom_targeting_value_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 = "CustomTargetingValueServiceProto";
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 `CustomTargetingValue` objects.
34
+ service CustomTargetingValueService {
35
+ option (google.api.default_host) = "admanager.googleapis.com";
36
+
37
+ // API to retrieve a `CustomTargetingValue` object.
38
+ rpc GetCustomTargetingValue(GetCustomTargetingValueRequest)
39
+ returns (CustomTargetingValue) {
40
+ option (google.api.http) = {
41
+ get: "/v1/{name=networks/*/customTargetingKeys/*/customTargetingValues/*}"
42
+ };
43
+ option (google.api.method_signature) = "name";
44
+ }
45
+
46
+ // API to retrieve a list of `CustomTargetingValue` objects.
47
+ rpc ListCustomTargetingValues(ListCustomTargetingValuesRequest)
48
+ returns (ListCustomTargetingValuesResponse) {
49
+ option (google.api.http) = {
50
+ get: "/v1/{parent=networks/*/customTargetingKeys/*}/customTargetingValues"
51
+ };
52
+ option (google.api.method_signature) = "parent";
53
+ }
54
+ }
55
+
56
+ // Request object for `GetCustomTargetingValue` method.
57
+ message GetCustomTargetingValueRequest {
58
+ // Required. The resource name of the CustomTargetingValue.
59
+ // Format:
60
+ // `networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}/customTargetingValues/{custom_targeting_value_id}`
61
+ string name = 1 [
62
+ (google.api.field_behavior) = REQUIRED,
63
+ (google.api.resource_reference) = {
64
+ type: "admanager.googleapis.com/CustomTargetingValue"
65
+ }
66
+ ];
67
+ }
68
+
69
+ // Request object for `ListCustomTargetingValues` method.
70
+ message ListCustomTargetingValuesRequest {
71
+ // Required. The parent, which owns this collection of CustomTargetingValues.
72
+ // Format:
73
+ // `networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}`
74
+ string parent = 1 [
75
+ (google.api.field_behavior) = REQUIRED,
76
+ (google.api.resource_reference) = {
77
+ type: "admanager.googleapis.com/CustomTargetingKey"
78
+ }
79
+ ];
80
+
81
+ // Optional. The maximum number of `CustomTargetingValues` to return. The
82
+ // service may return fewer than this value. If unspecified, at most 50
83
+ // `CustomTargetingValues` will be returned. The maximum value is 1000; values
84
+ // above 1000 will be coerced to 1000.
85
+ int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
86
+
87
+ // Optional. A page token, received from a previous
88
+ // `ListCustomTargetingValues` call. Provide this to retrieve the subsequent
89
+ // page.
90
+ //
91
+ // When paginating, all other parameters provided to
92
+ // `ListCustomTargetingValues` must match the call that provided the page
93
+ // token.
94
+ string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
95
+
96
+ // Optional. Expression to filter the response.
97
+ // See syntax details at
98
+ // https://developers.google.com/ad-manager/api/beta/filters
99
+ string filter = 4 [(google.api.field_behavior) = OPTIONAL];
100
+
101
+ // Optional. Expression to specify sorting order.
102
+ // See syntax details at
103
+ // https://developers.google.com/ad-manager/api/beta/filters#order
104
+ string order_by = 5 [(google.api.field_behavior) = OPTIONAL];
105
+
106
+ // Optional. Number of individual resources to skip while paginating.
107
+ int32 skip = 6 [(google.api.field_behavior) = OPTIONAL];
108
+ }
109
+
110
+ // Response object for `ListCustomTargetingValuesRequest` containing matching
111
+ // `CustomTargetingValue` objects.
112
+ message ListCustomTargetingValuesResponse {
113
+ // The `CustomTargetingValue` objects from the specified network.
114
+ repeated CustomTargetingValue custom_targeting_values = 1;
115
+
116
+ // A token, which can be sent as `page_token` to retrieve the next page.
117
+ // If this field is omitted, there are no subsequent pages.
118
+ string next_page_token = 2;
119
+
120
+ // Total number of `CustomTargetingValue` objects.
121
+ // If a filter was included in the request, this reflects the total number
122
+ // after the filtering is applied.
123
+ //
124
+ // `total_size` will not be calculated in the response unless it has been
125
+ // included in a response field mask. The response field mask can be provided
126
+ // to the method by using the URL parameter `$fields` or `fields`, or by using
127
+ // the HTTP/gRPC header `X-Goog-FieldMask`.
128
+ //
129
+ // For more information, see
130
+ // https://developers.google.com/ad-manager/api/beta/field-masks
131
+ int32 total_size = 3;
132
+ }