@google-ads/admanager 0.4.1 → 0.5.0

package/build/protos/google/ads/admanager/v1/application_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/application_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 = "ApplicationServiceProto";
+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 `Application` objects.
+service ApplicationService {
+  option (google.api.default_host) = "admanager.googleapis.com";
+  option (google.api.oauth_scopes) =
+      "https://www.googleapis.com/auth/admanager";
+
+  // API to retrieve a `Application` object.
+  rpc GetApplication(GetApplicationRequest) returns (Application) {
+    option (google.api.http) = {
+      get: "/v1/{name=networks/*/applications/*}"
+    };
+    option (google.api.method_signature) = "name";
+  }
+
+  // API to retrieve a list of `Application` objects.
+  rpc ListApplications(ListApplicationsRequest)
+      returns (ListApplicationsResponse) {
+    option (google.api.http) = {
+      get: "/v1/{parent=networks/*}/applications"
+    };
+    option (google.api.method_signature) = "parent";
+  }
+}
+
+// Request object for `GetApplication` method.
+message GetApplicationRequest {
+  // Required. The resource name of the Application.
+  // Format: `networks/{network_code}/applications/{application_id}`
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "admanager.googleapis.com/Application"
+    }
+  ];
+}
+
+// Request object for `ListApplications` method.
+message ListApplicationsRequest {
+  // Required. The parent, which owns this collection of Applications.
+  // 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 `Applications` to return. The service may
+  // return fewer than this value. If unspecified, at most 50 `Applications`
+  // 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 `ListApplications` call.
+  // Provide this to retrieve the subsequent page.
+  //
+  // When paginating, all other parameters provided to `ListApplications` 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 `ListApplicationsRequest` containing matching
+// `Application` objects.
+message ListApplicationsResponse {
+  // The `Application` objects from the specified network.
+  repeated Application applications = 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 `Application` 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/audience_segment_messages.proto

@@ -0,0 +1,49 @@
+// 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 = "AudienceSegmentMessagesProto";
+option java_package = "com.google.ads.admanager.v1";
+option php_namespace = "Google\\Ads\\AdManager\\V1";
+option ruby_package = "Google::Ads::AdManager::V1";
+
+// The `AudienceSegment` resource.
+message AudienceSegment {
+  option (google.api.resource) = {
+    type: "admanager.googleapis.com/AudienceSegment"
+    pattern: "networks/{network_code}/audienceSegments/{audience_segment}"
+    plural: "audienceSegments"
+    singular: "audienceSegment"
+  };
+
+  // Identifier. The resource name of the `AudienceSegment`.
+  // Format: `networks/{network_code}/audienceSegments/{audience_segment_id}`
+  // The `audience_segment_id` may have up to 1 of the following suffixes:
+  //   - `~direct` for directly licensed third-party segments
+  //   - `~global` for globally licensed third-party segments
+  string name = 1 [(google.api.field_behavior) = IDENTIFIER];
+
+  // Required. Display name of the `AudienceSegment`. The attribute has a
+  // maximum length of 255 characters.
+  optional string display_name = 2 [(google.api.field_behavior) = REQUIRED];
+}

package/build/protos/google/ads/admanager/v1/audience_segment_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/audience_segment_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 = "AudienceSegmentServiceProto";
+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 `AudienceSegment` objects.
+service AudienceSegmentService {
+  option (google.api.default_host) = "admanager.googleapis.com";
+  option (google.api.oauth_scopes) =
+      "https://www.googleapis.com/auth/admanager";
+
+  // API to retrieve an `AudienceSegment` object.
+  rpc GetAudienceSegment(GetAudienceSegmentRequest) returns (AudienceSegment) {
+    option (google.api.http) = {
+      get: "/v1/{name=networks/*/audienceSegments/*}"
+    };
+    option (google.api.method_signature) = "name";
+  }
+
+  // API to retrieve a list of `AudienceSegment` objects.
+  rpc ListAudienceSegments(ListAudienceSegmentsRequest)
+      returns (ListAudienceSegmentsResponse) {
+    option (google.api.http) = {
+      get: "/v1/{parent=networks/*}/audienceSegments"
+    };
+    option (google.api.method_signature) = "parent";
+  }
+}
+
+// Request object for `GetAudienceSegment` method.
+message GetAudienceSegmentRequest {
+  // Required. The resource name of the AudienceSegment.
+  // Format: `networks/{network_code}/audienceSegments/{audience_segment_id}`
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "admanager.googleapis.com/AudienceSegment"
+    }
+  ];
+}
+
+// Request object for `ListAudienceSegments` method.
+message ListAudienceSegmentsRequest {
+  // Required. The parent publisher network associated with these audience
+  // segments. 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 `AudienceSegments` to return. The service
+  // may return fewer than this value. If unspecified, at most 50
+  // `AudienceSegments` 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 `ListAudienceSegments`
+  // call. Provide this to retrieve the subsequent page.
+  //
+  // When paginating, all other parameters provided to `ListAudienceSegments`
+  // 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 `ListAudienceSegmentsRequest` containing matching
+// `AudienceSegment` objects.
+message ListAudienceSegmentsResponse {
+  // The `AudienceSegment` objects from the specified network.
+  repeated AudienceSegment audience_segments = 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 `AudienceSegment` 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/bandwidth_group_service.proto

@@ -79,8 +79,8 @@ message ListBandwidthGroupsRequest {
 
   // Optional. The maximum number of `BandwidthGroups` to return. The service
   // may return fewer than this value. If unspecified, at most 50
-  // `BandwidthGroups` will be returned. The maximum value is 1000; values above
-  // 1000 will be coerced to 1000.
+  // `BandwidthGroups` 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 `ListBandwidthGroups`
@@ -118,7 +118,7 @@ message ListBandwidthGroupsResponse {
   // 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/browser_language_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 = "BrowserLanguageMessagesProto";
+option java_package = "com.google.ads.admanager.v1";
+option php_namespace = "Google\\Ads\\AdManager\\V1";
+option ruby_package = "Google::Ads::AdManager::V1";
+
+// Represents the language of a browser.
+message BrowserLanguage {
+  option (google.api.resource) = {
+    type: "admanager.googleapis.com/BrowserLanguage"
+    pattern: "networks/{network_code}/browserLanguages/{browser_language}"
+    plural: "browserLanguages"
+    singular: "browserLanguage"
+  };
+
+  // Identifier. The resource name of the `BrowserLanguage`.
+  // Format: `networks/{network_code}/browserLanguages/{browser_language_id}`
+  string name = 1 [(google.api.field_behavior) = IDENTIFIER];
+
+  // Output only. The name of the browser language, localized.
+  optional string display_name = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+}

package/build/protos/google/ads/admanager/v1/browser_language_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/browser_language_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 = "BrowserLanguageServiceProto";
+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 `BrowserLanguage` objects.
+service BrowserLanguageService {
+  option (google.api.default_host) = "admanager.googleapis.com";
+  option (google.api.oauth_scopes) =
+      "https://www.googleapis.com/auth/admanager";
+
+  // API to retrieve a `BrowserLanguage` object.
+  rpc GetBrowserLanguage(GetBrowserLanguageRequest) returns (BrowserLanguage) {
+    option (google.api.http) = {
+      get: "/v1/{name=networks/*/browserLanguages/*}"
+    };
+    option (google.api.method_signature) = "name";
+  }
+
+  // API to retrieve a list of `BrowserLanguage` objects.
+  rpc ListBrowserLanguages(ListBrowserLanguagesRequest)
+      returns (ListBrowserLanguagesResponse) {
+    option (google.api.http) = {
+      get: "/v1/{parent=networks/*}/browserLanguages"
+    };
+    option (google.api.method_signature) = "parent";
+  }
+}
+
+// Request object for `GetBrowserLanguage` method.
+message GetBrowserLanguageRequest {
+  // Required. The resource name of the BrowserLanguage.
+  // Format: `networks/{network_code}/browserLanguages/{browser_language_id}`
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "admanager.googleapis.com/BrowserLanguage"
+    }
+  ];
+}
+
+// Request object for `ListBrowserLanguages` method.
+message ListBrowserLanguagesRequest {
+  // Required. The parent, which owns this collection of BrowserLanguages.
+  // 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 `BrowserLanguages` to return. The service
+  // may return fewer than this value. If unspecified, at most 50
+  // `BrowserLanguages` 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 `ListBrowserLanguages`
+  // call. Provide this to retrieve the subsequent page.
+  //
+  // When paginating, all other parameters provided to `ListBrowserLanguages`
+  // 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 `ListBrowserLanguagesRequest` containing matching
+// `BrowserLanguage` objects.
+message ListBrowserLanguagesResponse {
+  // The `BrowserLanguage` objects from the specified network.
+  repeated BrowserLanguage browser_languages = 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 `BrowserLanguage` 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/browser_messages.proto

@@ -0,0 +1,51 @@
+// 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 = "BrowserMessagesProto";
+option java_package = "com.google.ads.admanager.v1";
+option php_namespace = "Google\\Ads\\AdManager\\V1";
+option ruby_package = "Google::Ads::AdManager::V1";
+
+// Represents a browser, including its version.
+message Browser {
+  option (google.api.resource) = {
+    type: "admanager.googleapis.com/Browser"
+    pattern: "networks/{network_code}/browsers/{browser}"
+    plural: "browsers"
+    singular: "browser"
+  };
+
+  // Identifier. The resource name of the `Browser`.
+  // Format: `networks/{network_code}/browsers/{browser}`
+  string name = 1 [(google.api.field_behavior) = IDENTIFIER];
+
+  // Output only. The display name of the browser, including version info.
+  optional string display_name = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The major version of the browser.
+  optional string major_version = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The minor version of the browser.
+  optional string minor_version = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+}