@google-ads/admanager 0.4.1 → 0.5.0

package/build/protos/google/ads/admanager/v1/creative_template_service.proto

@@ -0,0 +1,130 @@
+// Copyright 2025 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package google.ads.admanager.v1;
+
+import "google/ads/admanager/v1/creative_template_messages.proto";
+import "google/api/annotations.proto";
+import "google/api/client.proto";
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+
+option csharp_namespace = "Google.Ads.AdManager.V1";
+option go_package = "google.golang.org/genproto/googleapis/ads/admanager/v1;admanager";
+option java_multiple_files = true;
+option java_outer_classname = "CreativeTemplateServiceProto";
+option java_package = "com.google.ads.admanager.v1";
+option php_namespace = "Google\\Ads\\AdManager\\V1";
+option ruby_package = "Google::Ads::AdManager::V1";
+
+// Provides methods for handling `CreativeTemplate` objects.
+service CreativeTemplateService {
+  option (google.api.default_host) = "admanager.googleapis.com";
+  option (google.api.oauth_scopes) =
+      "https://www.googleapis.com/auth/admanager";
+
+  // API to retrieve a `CreativeTemplate` object.
+  rpc GetCreativeTemplate(GetCreativeTemplateRequest)
+      returns (CreativeTemplate) {
+    option (google.api.http) = {
+      get: "/v1/{name=networks/*/creativeTemplates/*}"
+    };
+    option (google.api.method_signature) = "name";
+  }
+
+  // API to retrieve a list of `CreativeTemplate` objects.
+  rpc ListCreativeTemplates(ListCreativeTemplatesRequest)
+      returns (ListCreativeTemplatesResponse) {
+    option (google.api.http) = {
+      get: "/v1/{parent=networks/*}/creativeTemplates"
+    };
+    option (google.api.method_signature) = "parent";
+  }
+}
+
+// Request object for `GetCreativeTemplate` method.
+message GetCreativeTemplateRequest {
+  // Required. The resource name of the CreativeTemplate.
+  // Format: `networks/{network_code}/creativeTemplates/{creative_template_id}`
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "admanager.googleapis.com/CreativeTemplate"
+    }
+  ];
+}
+
+// Request object for `ListCreativeTemplates` method.
+message ListCreativeTemplatesRequest {
+  // Required. The parent, which owns this collection of CreativeTemplates.
+  // Format: `networks/{network_code}`
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "admanager.googleapis.com/Network"
+    }
+  ];
+
+  // Optional. The maximum number of `CreativeTemplates` to return. The service
+  // may return fewer than this value. If unspecified, at most 50
+  // `CreativeTemplates` will be returned. The maximum value is 1000; values
+  // greater than 1000 will be coerced to 1000.
+  int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. A page token, received from a previous `ListCreativeTemplates`
+  // call. Provide this to retrieve the subsequent page.
+  //
+  // When paginating, all other parameters provided to `ListCreativeTemplates`
+  // must match the call that provided the page token.
+  string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. Expression to filter the response.
+  // See syntax details at
+  // https://developers.google.com/ad-manager/api/beta/filters
+  string filter = 4 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. Expression to specify sorting order.
+  // See syntax details at
+  // https://developers.google.com/ad-manager/api/beta/filters#order
+  string order_by = 5 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. Number of individual resources to skip while paginating.
+  int32 skip = 6 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Response object for `ListCreativeTemplatesRequest` containing matching
+// `CreativeTemplate` objects.
+message ListCreativeTemplatesResponse {
+  // The `CreativeTemplate` objects from the specified network.
+  repeated CreativeTemplate creative_templates = 1;
+
+  // A token, which can be sent as `page_token` to retrieve the next page.
+  // If this field is omitted, there are no subsequent pages.
+  string next_page_token = 2;
+
+  // Total number of `CreativeTemplate` objects.
+  // If a filter was included in the request, this reflects the total number
+  // after the filtering is applied.
+  //
+  // `total_size` won't be calculated in the response unless it has been
+  // included in a response field mask. The response field mask can be provided
+  // to the method by using the URL parameter `$fields` or `fields`, or by using
+  // the HTTP/gRPC header `X-Goog-FieldMask`.
+  //
+  // For more information, see
+  // https://developers.google.com/ad-manager/api/beta/field-masks
+  int32 total_size = 3;
+}

package/build/protos/google/ads/admanager/v1/creative_template_variable_url_type_enum.proto

@@ -0,0 +1,47 @@
+// Copyright 2025 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package google.ads.admanager.v1;
+
+option csharp_namespace = "Google.Ads.AdManager.V1";
+option go_package = "google.golang.org/genproto/googleapis/ads/admanager/v1;admanager";
+option java_multiple_files = true;
+option java_outer_classname = "CreativeTemplateVariableUrlTypeEnumProto";
+option java_package = "com.google.ads.admanager.v1";
+option php_namespace = "Google\\Ads\\AdManager\\V1";
+option ruby_package = "Google::Ads::AdManager::V1";
+
+// Wrapper message for
+// [CreativeTemplateVariableUrlType][google.ads.admanager.v1.CreativeTemplateVariableUrlTypeEnum.CreativeTemplateVariableUrlType]
+message CreativeTemplateVariableUrlTypeEnum {
+  // Types of URLs that a UrlCreativeTemplateVariable can represent.
+  enum CreativeTemplateVariableUrlType {
+    // Default value. This value is unused.
+    CREATIVE_TEMPLATE_VARIABLE_URL_TYPE_UNSPECIFIED = 0;
+
+    // Click tracking URL.
+    CLICK_TRACKER = 1;
+
+    // Deep-link URL.
+    DEEPLINK = 2;
+
+    // Impression tracking URL.
+    IMPRESSION_TRACKER = 3;
+
+    // Standard HTTP URL.
+    STANDARD_HTTP = 4;
+  }
+}

package/build/protos/google/ads/admanager/v1/custom_field_messages.proto

@@ -78,8 +78,11 @@ message CustomField {
 
 // An option for a drop-down `CustomField`.
 message CustomFieldOption {
-  // Output only. `CustomFieldOption` ID.
-  int64 custom_field_option_id = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+  // Optional. Non-empty default. `CustomFieldOption` ID.
+  int64 custom_field_option_id = 1 [
+    (google.api.field_behavior) = OPTIONAL,
+    (google.api.field_behavior) = NON_EMPTY_DEFAULT
+  ];
 
   // Required. The display name of the `CustomFieldOption`.
   //

package/build/protos/google/ads/admanager/v1/custom_field_service.proto

@@ -21,6 +21,7 @@ import "google/api/annotations.proto";
 import "google/api/client.proto";
 import "google/api/field_behavior.proto";
 import "google/api/resource.proto";
+import "google/protobuf/field_mask.proto";
 
 option csharp_namespace = "Google.Ads.AdManager.V1";
 option go_package = "google.golang.org/genproto/googleapis/ads/admanager/v1;admanager";
@@ -52,6 +53,64 @@ service CustomFieldService {
     };
     option (google.api.method_signature) = "parent";
   }
+
+  // API to create a `CustomField` object.
+  rpc CreateCustomField(CreateCustomFieldRequest) returns (CustomField) {
+    option (google.api.http) = {
+      post: "/v1/{parent=networks/*}/customFields"
+      body: "custom_field"
+    };
+    option (google.api.method_signature) = "parent,custom_field";
+  }
+
+  // API to batch create `CustomField` objects.
+  rpc BatchCreateCustomFields(BatchCreateCustomFieldsRequest)
+      returns (BatchCreateCustomFieldsResponse) {
+    option (google.api.http) = {
+      post: "/v1/{parent=networks/*}/customFields:batchCreate"
+      body: "*"
+    };
+    option (google.api.method_signature) = "parent,requests";
+  }
+
+  // API to update a `CustomField` object.
+  rpc UpdateCustomField(UpdateCustomFieldRequest) returns (CustomField) {
+    option (google.api.http) = {
+      patch: "/v1/{custom_field.name=networks/*/customFields/*}"
+      body: "custom_field"
+    };
+    option (google.api.method_signature) = "custom_field,update_mask";
+  }
+
+  // API to batch update `CustomField` objects.
+  rpc BatchUpdateCustomFields(BatchUpdateCustomFieldsRequest)
+      returns (BatchUpdateCustomFieldsResponse) {
+    option (google.api.http) = {
+      post: "/v1/{parent=networks/*}/customFields:batchUpdate"
+      body: "*"
+    };
+    option (google.api.method_signature) = "parent,requests";
+  }
+
+  // Activates a list of `CustomField` objects.
+  rpc BatchActivateCustomFields(BatchActivateCustomFieldsRequest)
+      returns (BatchActivateCustomFieldsResponse) {
+    option (google.api.http) = {
+      post: "/v1/{parent=networks/*}/customFields:batchActivate"
+      body: "*"
+    };
+    option (google.api.method_signature) = "parent,names";
+  }
+
+  // Deactivates a list of `CustomField` objects.
+  rpc BatchDeactivateCustomFields(BatchDeactivateCustomFieldsRequest)
+      returns (BatchDeactivateCustomFieldsResponse) {
+    option (google.api.http) = {
+      post: "/v1/{parent=networks/*}/customFields:batchDeactivate"
+      body: "*"
+    };
+    option (google.api.method_signature) = "parent,names";
+  }
 }
 
 // Request object for `GetCustomField` method.
@@ -79,8 +138,8 @@ message ListCustomFieldsRequest {
 
   // Optional. The maximum number of `CustomFields` to return. The service may
   // return fewer than this value. If unspecified, at most 50 `CustomFields`
-  // will be returned. The maximum value is 1000; values above 1000 will be
-  // coerced to 1000.
+  // will be returned. The maximum value is 1000; values greater than 1000 will
+  // be coerced to 1000.
   int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
 
   // Optional. A page token, received from a previous `ListCustomFields` call.
@@ -118,7 +177,7 @@ message ListCustomFieldsResponse {
   // If a filter was included in the request, this reflects the total number
   // after the filtering is applied.
   //
-  // `total_size` will not be calculated in the response unless it has been
+  // `total_size` won't be calculated in the response unless it has been
   // included in a response field mask. The response field mask can be provided
   // to the method by using the URL parameter `$fields` or `fields`, or by using
   // the HTTP/gRPC header `X-Goog-FieldMask`.
@@ -127,3 +186,126 @@ message ListCustomFieldsResponse {
   // https://developers.google.com/ad-manager/api/beta/field-masks
   int32 total_size = 3;
 }
+
+// Request object for `CreateCustomField` method.
+message CreateCustomFieldRequest {
+  // Required. The parent resource where this `CustomField` will be created.
+  // Format: `networks/{network_code}`
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "admanager.googleapis.com/Network"
+    }
+  ];
+
+  // Required. The `CustomField` to create.
+  CustomField custom_field = 2 [(google.api.field_behavior) = REQUIRED];
+}
+
+// Request object for `BatchCreateCustomFields` method.
+message BatchCreateCustomFieldsRequest {
+  // Required. The parent resource where `CustomFields` will be created.
+  // Format: `networks/{network_code}`
+  // The parent field in the CreateCustomFieldRequest must match this
+  // field.
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "admanager.googleapis.com/Network"
+    }
+  ];
+
+  // Required. The `CustomField` objects to create.
+  // A maximum of 100 objects can be created in a batch.
+  repeated CreateCustomFieldRequest requests = 2
+      [(google.api.field_behavior) = REQUIRED];
+}
+
+// Response object for `BatchCreateCustomFields` method.
+message BatchCreateCustomFieldsResponse {
+  // The `CustomField` objects created.
+  repeated CustomField custom_fields = 1;
+}
+
+// Request object for `UpdateCustomField` method.
+message UpdateCustomFieldRequest {
+  // Required. The `CustomField` to update.
+  //
+  // The `CustomField`'s `name` is used to identify the `CustomField` to update.
+  CustomField custom_field = 1 [(google.api.field_behavior) = REQUIRED];
+
+  // Required. The list of fields to update.
+  google.protobuf.FieldMask update_mask = 2
+      [(google.api.field_behavior) = REQUIRED];
+}
+
+// Request object for `BatchUpdateCustomFields` method.
+message BatchUpdateCustomFieldsRequest {
+  // Required. The parent resource where `CustomFields` will be updated.
+  // Format: `networks/{network_code}`
+  // The parent field in the UpdateCustomFieldRequest must match this
+  // field.
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "admanager.googleapis.com/Network"
+    }
+  ];
+
+  // Required. The `CustomField` objects to update.
+  // A maximum of 100 objects can be updated in a batch.
+  repeated UpdateCustomFieldRequest requests = 2
+      [(google.api.field_behavior) = REQUIRED];
+}
+
+// Response object for `BatchUpdateCustomFields` method.
+message BatchUpdateCustomFieldsResponse {
+  // The `CustomField` objects updated.
+  repeated CustomField custom_fields = 1;
+}
+
+// Request message for `BatchActivateCustomFields` method.
+message BatchActivateCustomFieldsRequest {
+  // Required. Format: `networks/{network_code}`
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "admanager.googleapis.com/Network"
+    }
+  ];
+
+  // Required. The resource names of the `CustomField` objects to activate.
+  // Format: `networks/{network_code}/customFields/{custom_field_id}`
+  repeated string names = 3 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "admanager.googleapis.com/CustomField"
+    }
+  ];
+}
+
+// Response object for `BatchActivateCustomFields` method.
+message BatchActivateCustomFieldsResponse {}
+
+// Request message for `BatchDeactivateCustomFields` method.
+message BatchDeactivateCustomFieldsRequest {
+  // Required. Format: `networks/{network_code}`
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "admanager.googleapis.com/Network"
+    }
+  ];
+
+  // Required. The resource names of the `CustomField` objects to deactivate.
+  // Format: `networks/{network_code}/customFields/{custom_field_id}`
+  repeated string names = 3 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "admanager.googleapis.com/CustomField"
+    }
+  ];
+}
+
+// Response object for `BatchDeactivateCustomFields` method.
+message BatchDeactivateCustomFieldsResponse {}

package/build/protos/google/ads/admanager/v1/custom_targeting_key_messages.proto

@@ -43,27 +43,28 @@ message CustomTargetingKey {
   string name = 1 [(google.api.field_behavior) = IDENTIFIER];
 
   // Output only. `CustomTargetingKey` ID.
-  int64 custom_targeting_key_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+  optional int64 custom_targeting_key_id = 2
+      [(google.api.field_behavior) = OUTPUT_ONLY];
 
   // Immutable. Name of the key. Keys can contain up to 10 characters each. You
   // can use alphanumeric characters and symbols other than the following:
   // ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ], the white space character.
-  string ad_tag_name = 3 [(google.api.field_behavior) = IMMUTABLE];
+  optional string ad_tag_name = 3 [(google.api.field_behavior) = IMMUTABLE];
 
   // Optional. Descriptive name for the `CustomTargetingKey`.
-  string display_name = 4 [(google.api.field_behavior) = OPTIONAL];
+  optional string display_name = 4 [(google.api.field_behavior) = OPTIONAL];
 
   // Required. Indicates whether users will select from predefined values or
   // create new targeting values, while specifying targeting criteria for a line
   // item.
-  CustomTargetingKeyTypeEnum.CustomTargetingKeyType type = 5
+  optional CustomTargetingKeyTypeEnum.CustomTargetingKeyType type = 5
       [(google.api.field_behavior) = REQUIRED];
 
   // Output only. Status of the `CustomTargetingKey`.
-  CustomTargetingKeyStatusEnum.CustomTargetingKeyStatus status = 6
+  optional CustomTargetingKeyStatusEnum.CustomTargetingKeyStatus status = 6
       [(google.api.field_behavior) = OUTPUT_ONLY];
 
   // Required. Reportable state of the `CustomTargetingKey`.
-  CustomTargetingKeyReportableTypeEnum.CustomTargetingKeyReportableType
+  optional CustomTargetingKeyReportableTypeEnum.CustomTargetingKeyReportableType
       reportable_type = 7 [(google.api.field_behavior) = REQUIRED];
 }

package/build/protos/google/ads/admanager/v1/custom_targeting_key_service.proto

@@ -120,7 +120,7 @@ message ListCustomTargetingKeysResponse {
   // If a filter was included in the request, this reflects the total number
   // after the filtering is applied.
   //
-  // `total_size` will not be calculated in the response unless it has been
+  // `total_size` won't be calculated in the response unless it has been
   // included in a response field mask. The response field mask can be provided
   // to the method by using the URL parameter `$fields` or `fields`, or by using
   // the HTTP/gRPC header `X-Goog-FieldMask`.

package/build/protos/google/ads/admanager/v1/custom_targeting_value_messages.proto

@@ -45,7 +45,7 @@ message CustomTargetingValue {
   // Required. Immutable. The resource name of the `CustomTargetingKey`.
   // Format:
   // `networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}`
-  string custom_targeting_key = 8 [
+  optional string custom_targeting_key = 8 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.field_behavior) = IMMUTABLE,
     (google.api.resource_reference) = {
@@ -58,20 +58,20 @@ message CustomTargetingValue {
   // the following: ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ]. Values are
   // not data-specific; all values are treated as strings. For example, instead
   // of using "age>=18 AND <=34", try "18-34"
-  string ad_tag_name = 4 [(google.api.field_behavior) = IMMUTABLE];
+  optional string ad_tag_name = 4 [(google.api.field_behavior) = IMMUTABLE];
 
   // Optional. Descriptive name for the `CustomTargetingValue`.
-  string display_name = 5 [(google.api.field_behavior) = OPTIONAL];
+  optional string display_name = 5 [(google.api.field_behavior) = OPTIONAL];
 
   // Required. Immutable. The way in which the CustomTargetingValue.name strings
   // will be matched.
-  CustomTargetingValueMatchTypeEnum.CustomTargetingValueMatchType match_type = 6
-      [
-        (google.api.field_behavior) = IMMUTABLE,
-        (google.api.field_behavior) = REQUIRED
-      ];
+  optional CustomTargetingValueMatchTypeEnum.CustomTargetingValueMatchType
+      match_type = 6 [
+    (google.api.field_behavior) = IMMUTABLE,
+    (google.api.field_behavior) = REQUIRED
+  ];
 
   // Output only. Status of the `CustomTargetingValue`.
-  CustomTargetingValueStatusEnum.CustomTargetingValueStatus status = 7
+  optional CustomTargetingValueStatusEnum.CustomTargetingValueStatus status = 7
       [(google.api.field_behavior) = OUTPUT_ONLY];
 }

package/build/protos/google/ads/admanager/v1/custom_targeting_value_service.proto

@@ -129,7 +129,7 @@ message ListCustomTargetingValuesResponse {
   // If a filter was included in the request, this reflects the total number
   // after the filtering is applied.
   //
-  // `total_size` will not be calculated in the response unless it has been
+  // `total_size` won't be calculated in the response unless it has been
   // included in a response field mask. The response field mask can be provided
   // to the method by using the URL parameter `$fields` or `fields`, or by using
   // the HTTP/gRPC header `X-Goog-FieldMask`.

package/build/protos/google/ads/admanager/v1/device_capability_messages.proto

@@ -0,0 +1,45 @@
+// Copyright 2025 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package google.ads.admanager.v1;
+
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+
+option csharp_namespace = "Google.Ads.AdManager.V1";
+option go_package = "google.golang.org/genproto/googleapis/ads/admanager/v1;admanager";
+option java_multiple_files = true;
+option java_outer_classname = "DeviceCapabilityMessagesProto";
+option java_package = "com.google.ads.admanager.v1";
+option php_namespace = "Google\\Ads\\AdManager\\V1";
+option ruby_package = "Google::Ads::AdManager::V1";
+
+// Represents a device capability.
+message DeviceCapability {
+  option (google.api.resource) = {
+    type: "admanager.googleapis.com/DeviceCapability"
+    pattern: "networks/{network_code}/deviceCapabilities/{device_capability}"
+    plural: "deviceCapabilities"
+    singular: "deviceCapability"
+  };
+
+  // Identifier. The resource name of the `DeviceCapability`.
+  // Format: `networks/{network_code}/deviceCapabilities/{device_capability_id}`
+  string name = 1 [(google.api.field_behavior) = IDENTIFIER];
+
+  // Output only. The localized name of the device capability.
+  optional string display_name = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+}