@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,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/applied_label.proto";
20
+ import "google/ads/admanager/v1/company_credit_status_enum.proto";
21
+ import "google/ads/admanager/v1/company_type_enum.proto";
22
+ import "google/api/field_behavior.proto";
23
+ import "google/api/resource.proto";
24
+ import "google/protobuf/timestamp.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 = "CompanyMessagesProto";
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
+ // The `Company` resource.
35
+ message Company {
36
+ option (google.api.resource) = {
37
+ type: "admanager.googleapis.com/Company"
38
+ pattern: "networks/{network_code}/companies/{company}"
39
+ plural: "companies"
40
+ singular: "company"
41
+ };
42
+
43
+ // Identifier. The resource name of the `Company`.
44
+ // Format: `networks/{network_code}/companies/{company_id}`
45
+ string name = 1 [(google.api.field_behavior) = IDENTIFIER];
46
+
47
+ // Output only. `Company` ID.
48
+ int64 company_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
49
+
50
+ // Required. The display name of the `Company`.
51
+ //
52
+ // This value has a maximum length of 127 characters.
53
+ string display_name = 3 [(google.api.field_behavior) = REQUIRED];
54
+
55
+ // Required. The type of the `Company`.
56
+ CompanyTypeEnum.CompanyType type = 4 [(google.api.field_behavior) = REQUIRED];
57
+
58
+ // Optional. The address for the `Company`.
59
+ //
60
+ // This value has a maximum length of 1024 characters.
61
+ string address = 5 [(google.api.field_behavior) = OPTIONAL];
62
+
63
+ // Optional. The email for the `Company`.
64
+ //
65
+ // This value has a maximum length of 128 characters.
66
+ string email = 6 [(google.api.field_behavior) = OPTIONAL];
67
+
68
+ // Optional. The fax number for the `Company`.
69
+ //
70
+ // This value has a maximum length of 63 characters.
71
+ string fax = 7 [(google.api.field_behavior) = OPTIONAL];
72
+
73
+ // Optional. The phone number for the `Company`.
74
+ //
75
+ // This value has a maximum length of 63 characters.
76
+ string phone = 8 [(google.api.field_behavior) = OPTIONAL];
77
+
78
+ // Optional. The external ID for the `Company`.
79
+ //
80
+ // This value has a maximum length of 255 characters.
81
+ string external_id = 9 [(google.api.field_behavior) = OPTIONAL];
82
+
83
+ // Optional. Comments about the `Company`.
84
+ //
85
+ // This value has a maximum length of 1024 characters.
86
+ string comment = 10 [(google.api.field_behavior) = OPTIONAL];
87
+
88
+ // Optional. The credit status of the `Company`.
89
+ //
90
+ // This attribute defaults to `ACTIVE` if basic settings are enabled and
91
+ // `ON_HOLD` if advance settings are enabled.
92
+ CompanyCreditStatusEnum.CompanyCreditStatus credit_status = 11
93
+ [(google.api.field_behavior) = OPTIONAL];
94
+
95
+ // Optional. The labels that are directly applied to the `Company`.
96
+ repeated AppliedLabel applied_labels = 12
97
+ [(google.api.field_behavior) = OPTIONAL];
98
+
99
+ // Optional. The resource names of primary Contact of the `Company`.
100
+ // Format: "networks/{network_code}/contacts/{contact_id}"
101
+ optional string primary_contact = 13 [
102
+ (google.api.field_behavior) = OPTIONAL,
103
+ (google.api.resource_reference) = {
104
+ type: "admanager.googleapis.com/Contact"
105
+ }
106
+ ];
107
+
108
+ // Optional. The resource names of Teams that are directly associated with the
109
+ // `Company`. Format: "networks/{network_code}/teams/{team_id}"
110
+ repeated string applied_teams = 14 [
111
+ (google.api.field_behavior) = OPTIONAL,
112
+ (google.api.resource_reference) = { type: "admanager.googleapis.com/Team" }
113
+ ];
114
+
115
+ // Output only. The time the `Company` was last modified.
116
+ google.protobuf.Timestamp update_time = 15
117
+ [(google.api.field_behavior) = OUTPUT_ONLY];
118
+
119
+ // Optional. The ID of the Google-recognized canonicalized form of the
120
+ // `Company`.
121
+ int64 third_party_company_id = 16 [(google.api.field_behavior) = OPTIONAL];
122
+ }
@@ -0,0 +1,126 @@
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/company_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 = "CompanyServiceProto";
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 `Company` objects.
34
+ service CompanyService {
35
+ option (google.api.default_host) = "admanager.googleapis.com";
36
+
37
+ // API to retrieve a `Company` object.
38
+ rpc GetCompany(GetCompanyRequest) returns (Company) {
39
+ option (google.api.http) = {
40
+ get: "/v1/{name=networks/*/companies/*}"
41
+ };
42
+ option (google.api.method_signature) = "name";
43
+ }
44
+
45
+ // API to retrieve a list of `Company` objects.
46
+ rpc ListCompanies(ListCompaniesRequest) returns (ListCompaniesResponse) {
47
+ option (google.api.http) = {
48
+ get: "/v1/{parent=networks/*}/companies"
49
+ };
50
+ option (google.api.method_signature) = "parent";
51
+ }
52
+ }
53
+
54
+ // Request object for `GetCompany` method.
55
+ message GetCompanyRequest {
56
+ // Required. The resource name of the Company.
57
+ // Format: `networks/{network_code}/companies/{company_id}`
58
+ string name = 1 [
59
+ (google.api.field_behavior) = REQUIRED,
60
+ (google.api.resource_reference) = {
61
+ type: "admanager.googleapis.com/Company"
62
+ }
63
+ ];
64
+ }
65
+
66
+ // Request object for `ListCompanies` method.
67
+ message ListCompaniesRequest {
68
+ // Required. The parent, which owns this collection of Companies.
69
+ // Format: `networks/{network_code}`
70
+ string parent = 1 [
71
+ (google.api.field_behavior) = REQUIRED,
72
+ (google.api.resource_reference) = {
73
+ type: "admanager.googleapis.com/Network"
74
+ }
75
+ ];
76
+
77
+ // Optional. The maximum number of `Companies` to return. The service may
78
+ // return fewer than this value. If unspecified, at most 50 `Companies` will
79
+ // be returned. The maximum value is 1000; values above 1000 will be coerced
80
+ // to 1000.
81
+ int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
82
+
83
+ // Optional. A page token, received from a previous `ListCompanies` call.
84
+ // Provide this to retrieve the subsequent page.
85
+ //
86
+ // When paginating, all other parameters provided to `ListCompanies` must
87
+ // match the call that provided the page token.
88
+ string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
89
+
90
+ // Optional. Expression to filter the response.
91
+ // See syntax details at
92
+ // https://developers.google.com/ad-manager/api/beta/filters
93
+ string filter = 4 [(google.api.field_behavior) = OPTIONAL];
94
+
95
+ // Optional. Expression to specify sorting order.
96
+ // See syntax details at
97
+ // https://developers.google.com/ad-manager/api/beta/filters#order
98
+ string order_by = 5 [(google.api.field_behavior) = OPTIONAL];
99
+
100
+ // Optional. Number of individual resources to skip while paginating.
101
+ int32 skip = 6 [(google.api.field_behavior) = OPTIONAL];
102
+ }
103
+
104
+ // Response object for `ListCompaniesRequest` containing matching `Company`
105
+ // objects.
106
+ message ListCompaniesResponse {
107
+ // The `Company` objects from the specified network.
108
+ repeated Company companies = 1;
109
+
110
+ // A token, which can be sent as `page_token` to retrieve the next page.
111
+ // If this field is omitted, there are no subsequent pages.
112
+ string next_page_token = 2;
113
+
114
+ // Total number of `Company` objects.
115
+ // If a filter was included in the request, this reflects the total number
116
+ // after the filtering is applied.
117
+ //
118
+ // `total_size` will not be calculated in the response unless it has been
119
+ // included in a response field mask. The response field mask can be provided
120
+ // to the method by using the URL parameter `$fields` or `fields`, or by using
121
+ // the HTTP/gRPC header `X-Goog-FieldMask`.
122
+ //
123
+ // For more information, see
124
+ // https://developers.google.com/ad-manager/api/beta/field-masks
125
+ int32 total_size = 3;
126
+ }
@@ -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 = "CompanyTypeEnumProto";
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
+ // [CompanyType][google.ads.admanager.v1.CompanyTypeEnum.CompanyType]
29
+ message CompanyTypeEnum {
30
+ // The type of a company.
31
+ enum CompanyType {
32
+ // No value specified
33
+ COMPANY_TYPE_UNSPECIFIED = 0;
34
+
35
+ // A business entity that purchases ad inventory.
36
+ ADVERTISER = 1;
37
+
38
+ // A company representing the publisher's own advertiser for house ads.
39
+ HOUSE_ADVERTISER = 2;
40
+
41
+ // An organization that manages ad accounts and offers services, such as ad
42
+ // creation, placement, and management to advertisers.
43
+ AGENCY = 3;
44
+
45
+ // A company representing the publisher's own agency.
46
+ HOUSE_AGENCY = 4;
47
+
48
+ // A company representing multiple advertisers and agencies.
49
+ AD_NETWORK = 5;
50
+ }
51
+ }
@@ -0,0 +1,49 @@
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 = "ContactMessagesProto";
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 contact represents a person who is affiliated with a single company. A
31
+ // contact can have a variety of contact information associated to it, and can
32
+ // be invited to view their company's orders, line items, creatives, and
33
+ // reports.
34
+ message Contact {
35
+ option (google.api.resource) = {
36
+ type: "admanager.googleapis.com/Contact"
37
+ pattern: "networks/{network_code}/contacts/{contact}"
38
+ plural: "contacts"
39
+ singular: "contact"
40
+ };
41
+
42
+ // Identifier. The resource name of the `Contact`.
43
+ // Format: `networks/{network_code}/contacts/{contact_id}`
44
+ string name = 1 [(google.api.field_behavior) = IDENTIFIER];
45
+
46
+ // Output only. The unique ID of the contact. This value is readonly and is
47
+ // assigned by Google.
48
+ int64 contact_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
49
+ }
@@ -0,0 +1,110 @@
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 = "CustomFieldEnumsProto";
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
+ // [CustomFieldDataType][google.ads.admanager.v1.CustomFieldDataTypeEnum.CustomFieldDataType]
29
+ message CustomFieldDataTypeEnum {
30
+ // The data type for a CustomField.
31
+ enum CustomFieldDataType {
32
+ // No value specified
33
+ CUSTOM_FIELD_DATA_TYPE_UNSPECIFIED = 0;
34
+
35
+ // A string field
36
+ //
37
+ // The max length is 255 characters.
38
+ STRING = 1;
39
+
40
+ // A number field.
41
+ NUMBER = 2;
42
+
43
+ // A "Yes" or "No" toggle field.
44
+ TOGGLE = 3;
45
+
46
+ // A drop-down field.
47
+ DROP_DOWN = 4;
48
+ }
49
+ }
50
+
51
+ // Wrapper message for
52
+ // [CustomFieldEntityType][google.ads.admanager.v1.CustomFieldEntityTypeEnum.CustomFieldEntityType]
53
+ message CustomFieldEntityTypeEnum {
54
+ // The types of entities that a CustomField can be applied to.
55
+ enum CustomFieldEntityType {
56
+ // No value specified
57
+ CUSTOM_FIELD_ENTITY_TYPE_UNSPECIFIED = 0;
58
+
59
+ // The CustomField is applied to LineItems.
60
+ LINE_ITEM = 1;
61
+
62
+ // The CustomField is applied to Orders.
63
+ ORDER = 2;
64
+
65
+ // The CustomField is applied to Creatives.
66
+ CREATIVE = 3;
67
+
68
+ // The CustomField is applied to Proposals.
69
+ PROPOSAL = 4;
70
+
71
+ // The CustomField is applied to ProposalLineItems.
72
+ PROPOSAL_LINE_ITEM = 5;
73
+ }
74
+ }
75
+
76
+ // Wrapper message for
77
+ // [CustomFieldStatus][google.ads.admanager.v1.CustomFieldStatusEnum.CustomFieldStatus]
78
+ message CustomFieldStatusEnum {
79
+ // The status of the CustomField.
80
+ enum CustomFieldStatus {
81
+ // No value specified
82
+ CUSTOM_FIELD_STATUS_UNSPECIFIED = 0;
83
+
84
+ // The CustomField is active.
85
+ ACTIVE = 1;
86
+
87
+ // The CustomField is inactive.
88
+ INACTIVE = 2;
89
+ }
90
+ }
91
+
92
+ // Wrapper message for
93
+ // [CustomFieldVisibility][google.ads.admanager.v1.CustomFieldVisibilityEnum.CustomFieldVisibility]
94
+ message CustomFieldVisibilityEnum {
95
+ // The visibility level of a CustomField.
96
+ enum CustomFieldVisibility {
97
+ // No value specified
98
+ CUSTOM_FIELD_VISIBILITY_UNSPECIFIED = 0;
99
+
100
+ // The CustomField is not visible in the UI and only visible through the
101
+ // API.
102
+ HIDDEN = 1;
103
+
104
+ // The CustomField is visible in the UI and only editable through the API.
105
+ READ_ONLY = 2;
106
+
107
+ // The CustomField is visible and editable in both the API and UI.
108
+ EDITABLE = 3;
109
+ }
110
+ }
@@ -0,0 +1,87 @@
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_field_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 = "CustomFieldMessagesProto";
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
+ // An additional, user-created field on an entity.
32
+ message CustomField {
33
+ option (google.api.resource) = {
34
+ type: "admanager.googleapis.com/CustomField"
35
+ pattern: "networks/{network_code}/customFields/{custom_field}"
36
+ plural: "customFields"
37
+ singular: "customField"
38
+ };
39
+
40
+ // Identifier. The resource name of the `CustomField`.
41
+ // Format: `networks/{network_code}/customFields/{custom_field_id}`
42
+ string name = 1 [(google.api.field_behavior) = IDENTIFIER];
43
+
44
+ // Output only. Unique ID of the CustomField. This value is readonly and is
45
+ // assigned by Google.
46
+ int64 custom_field_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
47
+
48
+ // Required. Name of the CustomField. The max length is 127 characters.
49
+ string display_name = 3 [(google.api.field_behavior) = REQUIRED];
50
+
51
+ // Optional. A description of the custom field. The maximum length is 511
52
+ // characters.
53
+ string description = 4 [(google.api.field_behavior) = OPTIONAL];
54
+
55
+ // Output only. The status of the `CustomField`.
56
+ CustomFieldStatusEnum.CustomFieldStatus status = 5
57
+ [(google.api.field_behavior) = OUTPUT_ONLY];
58
+
59
+ // Required. The type of entity the `CustomField` can be applied to.
60
+ CustomFieldEntityTypeEnum.CustomFieldEntityType entity_type = 7
61
+ [(google.api.field_behavior) = REQUIRED];
62
+
63
+ // Required. The data type of the `CustomField`.
64
+ CustomFieldDataTypeEnum.CustomFieldDataType data_type = 8
65
+ [(google.api.field_behavior) = REQUIRED];
66
+
67
+ // Required. The visibility of the `CustomField`.
68
+ CustomFieldVisibilityEnum.CustomFieldVisibility visibility = 9
69
+ [(google.api.field_behavior) = REQUIRED];
70
+
71
+ // Optional. The drop-down options for the `CustomField`.
72
+ //
73
+ // Only applicable for `CustomField` with the drop-down data type.
74
+ repeated CustomFieldOption options = 10
75
+ [(google.api.field_behavior) = OPTIONAL];
76
+ }
77
+
78
+ // An option for a drop-down `CustomField`.
79
+ message CustomFieldOption {
80
+ // Output only. `CustomFieldOption` ID.
81
+ int64 custom_field_option_id = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
82
+
83
+ // Required. The display name of the `CustomFieldOption`.
84
+ //
85
+ // This value has a maximum length of 127 characters.
86
+ string display_name = 2 [(google.api.field_behavior) = REQUIRED];
87
+ }
@@ -0,0 +1,127 @@
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_field_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 = "CustomFieldServiceProto";
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 `CustomField` objects.
34
+ service CustomFieldService {
35
+ option (google.api.default_host) = "admanager.googleapis.com";
36
+
37
+ // API to retrieve a `CustomField` object.
38
+ rpc GetCustomField(GetCustomFieldRequest) returns (CustomField) {
39
+ option (google.api.http) = {
40
+ get: "/v1/{name=networks/*/customFields/*}"
41
+ };
42
+ option (google.api.method_signature) = "name";
43
+ }
44
+
45
+ // API to retrieve a list of `CustomField` objects.
46
+ rpc ListCustomFields(ListCustomFieldsRequest)
47
+ returns (ListCustomFieldsResponse) {
48
+ option (google.api.http) = {
49
+ get: "/v1/{parent=networks/*}/customFields"
50
+ };
51
+ option (google.api.method_signature) = "parent";
52
+ }
53
+ }
54
+
55
+ // Request object for `GetCustomField` method.
56
+ message GetCustomFieldRequest {
57
+ // Required. The resource name of the CustomField.
58
+ // Format: `networks/{network_code}/customFields/{custom_field_id}`
59
+ string name = 1 [
60
+ (google.api.field_behavior) = REQUIRED,
61
+ (google.api.resource_reference) = {
62
+ type: "admanager.googleapis.com/CustomField"
63
+ }
64
+ ];
65
+ }
66
+
67
+ // Request object for `ListCustomFields` method.
68
+ message ListCustomFieldsRequest {
69
+ // Required. The parent, which owns this collection of CustomFields.
70
+ // Format: `networks/{network_code}`
71
+ string parent = 1 [
72
+ (google.api.field_behavior) = REQUIRED,
73
+ (google.api.resource_reference) = {
74
+ type: "admanager.googleapis.com/Network"
75
+ }
76
+ ];
77
+
78
+ // Optional. The maximum number of `CustomFields` to return. The service may
79
+ // return fewer than this value. If unspecified, at most 50 `CustomFields`
80
+ // will be returned. The maximum value is 1000; values above 1000 will be
81
+ // coerced to 1000.
82
+ int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
83
+
84
+ // Optional. A page token, received from a previous `ListCustomFields` call.
85
+ // Provide this to retrieve the subsequent page.
86
+ //
87
+ // When paginating, all other parameters provided to `ListCustomFields` must
88
+ // match the call that provided the page token.
89
+ string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
90
+
91
+ // Optional. Expression to filter the response.
92
+ // See syntax details at
93
+ // https://developers.google.com/ad-manager/api/beta/filters
94
+ string filter = 4 [(google.api.field_behavior) = OPTIONAL];
95
+
96
+ // Optional. Expression to specify sorting order.
97
+ // See syntax details at
98
+ // https://developers.google.com/ad-manager/api/beta/filters#order
99
+ string order_by = 5 [(google.api.field_behavior) = OPTIONAL];
100
+
101
+ // Optional. Number of individual resources to skip while paginating.
102
+ int32 skip = 6 [(google.api.field_behavior) = OPTIONAL];
103
+ }
104
+
105
+ // Response object for `ListCustomFieldsRequest` containing matching
106
+ // `CustomField` objects.
107
+ message ListCustomFieldsResponse {
108
+ // The `CustomField` objects from the specified network.
109
+ repeated CustomField custom_fields = 1;
110
+
111
+ // A token, which can be sent as `page_token` to retrieve the next page.
112
+ // If this field is omitted, there are no subsequent pages.
113
+ string next_page_token = 2;
114
+
115
+ // Total number of `CustomField` objects.
116
+ // If a filter was included in the request, this reflects the total number
117
+ // after the filtering is applied.
118
+ //
119
+ // `total_size` will not be calculated in the response unless it has been
120
+ // included in a response field mask. The response field mask can be provided
121
+ // to the method by using the URL parameter `$fields` or `fields`, or by using
122
+ // the HTTP/gRPC header `X-Goog-FieldMask`.
123
+ //
124
+ // For more information, see
125
+ // https://developers.google.com/ad-manager/api/beta/field-masks
126
+ int32 total_size = 3;
127
+ }