@google-ads/admanager 0.4.1 → 0.5.1

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

@@ -0,0 +1,53 @@
+// 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 = "ContentBundleMessagesProto";
+option java_package = "com.google.ads.admanager.v1";
+option php_namespace = "Google\\Ads\\AdManager\\V1";
+option ruby_package = "Google::Ads::AdManager::V1";
+
+// A [ContentBundle][google.ads.admanager.v1.ContentBundle] is a grouping of
+// individual [Content][google.ads.admanager.v1.Content]. A
+// [ContentBundle][google.ads.admanager.v1.ContentBundle] is defined as
+// including the [Content][google.ads.admanager.v1.Content] that match certain
+// filter rules along with the option to explicitly include or exclude certain
+// Content IDs.
+message ContentBundle {
+  option (google.api.resource) = {
+    type: "admanager.googleapis.com/ContentBundle"
+    pattern: "networks/{network_code}/contentBundles/{content_bundle}"
+    plural: "contentBundles"
+    singular: "contentBundle"
+  };
+
+  // Identifier. The resource name of the
+  // [ContentBundle][google.ads.admanager.v1.ContentBundle]. Format:
+  // `networks/{network_code}/contentBundles/{content_bundle_id}`
+  string name = 1 [(google.api.field_behavior) = IDENTIFIER];
+
+  // Required. The name of the
+  // [ContentBundle][google.ads.admanager.v1.ContentBundle]. This attribute is
+  // required and has a maximum length of 255 characters.
+  string display_name = 3 [(google.api.field_behavior) = REQUIRED];
+}

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

@@ -0,0 +1,129 @@
+// 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/content_bundle_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 = "ContentBundleServiceProto";
+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 `ContentBundle` objects.
+service ContentBundleService {
+  option (google.api.default_host) = "admanager.googleapis.com";
+  option (google.api.oauth_scopes) =
+      "https://www.googleapis.com/auth/admanager";
+
+  // API to retrieve a `ContentBundle` object.
+  rpc GetContentBundle(GetContentBundleRequest) returns (ContentBundle) {
+    option (google.api.http) = {
+      get: "/v1/{name=networks/*/contentBundles/*}"
+    };
+    option (google.api.method_signature) = "name";
+  }
+
+  // API to retrieve a list of `ContentBundle` objects.
+  rpc ListContentBundles(ListContentBundlesRequest)
+      returns (ListContentBundlesResponse) {
+    option (google.api.http) = {
+      get: "/v1/{parent=networks/*}/contentBundles"
+    };
+    option (google.api.method_signature) = "parent";
+  }
+}
+
+// Request object for `GetContentBundle` method.
+message GetContentBundleRequest {
+  // Required. The resource name of the ContentBundle.
+  // Format: `networks/{network_code}/contentBundles/{content_bundle_id}`
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "admanager.googleapis.com/ContentBundle"
+    }
+  ];
+}
+
+// Request object for `ListContentBundles` method.
+message ListContentBundlesRequest {
+  // Required. The parent, which owns this collection of ContentBundles.
+  // 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 `ContentBundles` to return. The service may
+  // return fewer than this value. If unspecified, at most 50 `ContentBundles`
+  // 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 `ListContentBundles` call.
+  // Provide this to retrieve the subsequent page.
+  //
+  // When paginating, all other parameters provided to `ListContentBundles` 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 `ListContentBundlesRequest` containing matching
+// `ContentBundle` objects.
+message ListContentBundlesResponse {
+  // The `ContentBundle` objects from the specified network.
+  repeated ContentBundle content_bundles = 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 `ContentBundle` 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/content_label_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 = "ContentLabelMessagesProto";
+option java_package = "com.google.ads.admanager.v1";
+option php_namespace = "Google\\Ads\\AdManager\\V1";
+option ruby_package = "Google::Ads::AdManager::V1";
+
+// A content label.
+message ContentLabel {
+  option (google.api.resource) = {
+    type: "admanager.googleapis.com/ContentLabel"
+    pattern: "networks/{network_code}/contentLabels/{content_label}"
+    plural: "contentLabels"
+    singular: "contentLabel"
+  };
+
+  // Identifier. The resource name of the `ContentLabel`.
+  // Format: `networks/{network_code}/contentLabels/{content_label_id}`
+  string name = 1 [(google.api.field_behavior) = IDENTIFIER];
+
+  // Optional. The display name of the `ContentLabel`.
+  string display_name = 2 [(google.api.field_behavior) = OPTIONAL];
+}

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

@@ -0,0 +1,129 @@
+// 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/content_label_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 = "ContentLabelServiceProto";
+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 `ContentLabel` objects.
+service ContentLabelService {
+  option (google.api.default_host) = "admanager.googleapis.com";
+  option (google.api.oauth_scopes) =
+      "https://www.googleapis.com/auth/admanager";
+
+  // API to retrieve a `ContentLabel` object.
+  rpc GetContentLabel(GetContentLabelRequest) returns (ContentLabel) {
+    option (google.api.http) = {
+      get: "/v1/{name=networks/*/contentLabels/*}"
+    };
+    option (google.api.method_signature) = "name";
+  }
+
+  // API to retrieve a list of `ContentLabel` objects.
+  rpc ListContentLabels(ListContentLabelsRequest)
+      returns (ListContentLabelsResponse) {
+    option (google.api.http) = {
+      get: "/v1/{parent=networks/*}/contentLabels"
+    };
+    option (google.api.method_signature) = "parent";
+  }
+}
+
+// Request object for `GetContentLabel` method.
+message GetContentLabelRequest {
+  // Required. The resource name of the ContentLabel.
+  // Format: `networks/{network_code}/contentLabels/{content_label_id}`
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "admanager.googleapis.com/ContentLabel"
+    }
+  ];
+}
+
+// Request object for `ListContentLabels` method.
+message ListContentLabelsRequest {
+  // Required. The parent, which owns this collection of ContentLabels.
+  // 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 `ContentLabels` to return. The service may
+  // return fewer than this value. If unspecified, at most 50 `ContentLabels`
+  // 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 `ListContentLabels` call.
+  // Provide this to retrieve the subsequent page.
+  //
+  // When paginating, all other parameters provided to `ListContentLabels` 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 `ListContentLabelsRequest` containing matching
+// `ContentLabel` objects.
+message ListContentLabelsResponse {
+  // The `ContentLabel` objects from the specified network.
+  repeated ContentLabel content_labels = 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 `ContentLabel` 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/content_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 = "ContentMessagesProto";
+option java_package = "com.google.ads.admanager.v1";
+option php_namespace = "Google\\Ads\\AdManager\\V1";
+option ruby_package = "Google::Ads::AdManager::V1";
+
+// A piece of content from a Publisher's CMS.
+message Content {
+  option (google.api.resource) = {
+    type: "admanager.googleapis.com/Content"
+    pattern: "networks/{network_code}/content/{content}"
+    plural: "content"
+    singular: "content"
+  };
+
+  // Identifier. The resource name of the `Content`.
+  // Format: `networks/{network_code}/content/{content_id}`
+  string name = 1 [(google.api.field_behavior) = IDENTIFIER];
+
+  // Output only. The name of the `Content`.
+  optional string display_name = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+}

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

@@ -0,0 +1,128 @@
+// 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/content_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 = "ContentServiceProto";
+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 `Content` objects.
+service ContentService {
+  option (google.api.default_host) = "admanager.googleapis.com";
+  option (google.api.oauth_scopes) =
+      "https://www.googleapis.com/auth/admanager";
+
+  // API to retrieve a `Content` object.
+  rpc GetContent(GetContentRequest) returns (Content) {
+    option (google.api.http) = {
+      get: "/v1/{name=networks/*/content/*}"
+    };
+    option (google.api.method_signature) = "name";
+  }
+
+  // API to retrieve a list of `Content` objects.
+  rpc ListContent(ListContentRequest) returns (ListContentResponse) {
+    option (google.api.http) = {
+      get: "/v1/{parent=networks/*}/content"
+    };
+    option (google.api.method_signature) = "parent";
+  }
+}
+
+// Request object for `GetContent` method.
+message GetContentRequest {
+  // Required. The resource name of the Content.
+  // Format: `networks/{network_code}/content/{content_id}`
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "admanager.googleapis.com/Content"
+    }
+  ];
+}
+
+// Request object for `ListContent` method.
+message ListContentRequest {
+  // Required. The parent, which owns this collection of Content.
+  // 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 `Content` to return. The service may return
+  // fewer than this value. If unspecified, at most 50 `Content` 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 `ListContent` call.
+  // Provide this to retrieve the subsequent page.
+  //
+  // When paginating, all other parameters provided to `ListContent` 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 `ListContentRequest` containing matching `Content`
+// objects.
+message ListContentResponse {
+  // The `Content` objects from the specified network.
+  repeated Content content = 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 `Content` 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_enums.proto

@@ -0,0 +1,63 @@
+// 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 = "CreativeTemplateEnumsProto";
+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
+// [CreativeTemplateType][google.ads.admanager.v1.CreativeTemplateTypeEnum.CreativeTemplateType]
+message CreativeTemplateTypeEnum {
+  // Describes type of the creative template.
+  enum CreativeTemplateType {
+    // Default value. This value is unused.
+    CREATIVE_TEMPLATE_TYPE_UNSPECIFIED = 0;
+
+    // Creative templates that are included in Ad Manager by default.
+    STANDARD = 1;
+
+    // Creative templates created by an administrator or other user in the
+    // network.
+    CUSTOM = 2;
+  }
+}
+
+// Wrapper message for
+// [CreativeTemplateStatus][google.ads.admanager.v1.CreativeTemplateStatusEnum.CreativeTemplateStatus]
+message CreativeTemplateStatusEnum {
+  // Describes status of the creative template
+  enum CreativeTemplateStatus {
+    // Default value. This value is unused.
+    CREATIVE_TEMPLATE_STATUS_UNSPECIFIED = 0;
+
+    // The CreativeTemplate is active
+    ACTIVE = 1;
+
+    // The CreativeTemplate is deleted. Creatives created from this
+    // CreativeTemplate can no longer serve.
+    DELETED = 2;
+
+    // The CreativeTemplate is inactive. Users cannot create new creatives
+    // from this template, but existing ones can be edited and continue to serve
+    INACTIVE = 3;
+  }
+}