@google-ads/admanager 0.3.0 → 0.4.0

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

@@ -0,0 +1,72 @@
+// 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 = "ProgrammaticBuyerMessagesProto";
+option java_package = "com.google.ads.admanager.v1";
+option php_namespace = "Google\\Ads\\AdManager\\V1";
+option ruby_package = "Google::Ads::AdManager::V1";
+
+// Represents a programmatic buyer.
+message ProgrammaticBuyer {
+  option (google.api.resource) = {
+    type: "admanager.googleapis.com/ProgrammaticBuyer"
+    pattern: "networks/{network_code}/programmaticBuyers/{programmatic_buyer}"
+    plural: "programmaticBuyers"
+    singular: "programmaticBuyer"
+  };
+
+  // Identifier. The resource name of the `ProgrammaticBuyer`.
+  // Format:
+  // `networks/{network_code}/programmaticBuyers/{buyer_account_id}`
+  string name = 1 [(google.api.field_behavior) = IDENTIFIER];
+
+  // Output only. The buyer account ID of the buyer.
+  optional int64 buyer_account_id = 2
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The display name of the buyer.
+  optional string display_name = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The ID of the programmatic buyer's sponsor. If the buyer has
+  // no sponsor, this field will be -1.
+  optional int64 parent_account_id = 6
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. ID of the Display & Video 360 client buyer partner ID (if
+  // Display & Video 360) or Authorized Buyers client buyer account ID.
+  optional string partner_client_id = 7
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Whether the buyer is an advertising agency.
+  optional bool agency = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Whether the buyer is enabled for preferred deals.
+  optional bool preferred_deals_enabled = 12
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Whether the buyer is enabled for programmatic guaranteed
+  // deals.
+  optional bool programmatic_guaranteed_enabled = 13
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+}

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

@@ -0,0 +1,131 @@
+// 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/programmatic_buyer_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 = "ProgrammaticBuyerServiceProto";
+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 `ProgrammaticBuyer` objects.
+service ProgrammaticBuyerService {
+  option (google.api.default_host) = "admanager.googleapis.com";
+  option (google.api.oauth_scopes) =
+      "https://www.googleapis.com/auth/admanager";
+
+  // API to retrieve a `ProgrammaticBuyer` object.
+  rpc GetProgrammaticBuyer(GetProgrammaticBuyerRequest)
+      returns (ProgrammaticBuyer) {
+    option (google.api.http) = {
+      get: "/v1/{name=networks/*/programmaticBuyers/*}"
+    };
+    option (google.api.method_signature) = "name";
+  }
+
+  // API to retrieve a list of `ProgrammaticBuyer` objects.
+  rpc ListProgrammaticBuyers(ListProgrammaticBuyersRequest)
+      returns (ListProgrammaticBuyersResponse) {
+    option (google.api.http) = {
+      get: "/v1/{parent=networks/*}/programmaticBuyers"
+    };
+    option (google.api.method_signature) = "parent";
+  }
+}
+
+// Request object for `GetProgrammaticBuyer` method.
+message GetProgrammaticBuyerRequest {
+  // Required. The resource name of the ProgrammaticBuyer.
+  // Format:
+  // `networks/{network_code}/programmaticBuyers/{buyer_account_id}`
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "admanager.googleapis.com/ProgrammaticBuyer"
+    }
+  ];
+}
+
+// Request object for `ListProgrammaticBuyers` method.
+message ListProgrammaticBuyersRequest {
+  // Required. The parent, which owns this collection of ProgrammaticBuyers.
+  // 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 `ProgrammaticBuyers` to return. The service
+  // may return fewer than this value. If unspecified, at most 50
+  // `ProgrammaticBuyers` will be returned. The maximum value is 1000; values
+  // above 1000 will be coerced to 1000.
+  int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. A page token, received from a previous `ListProgrammaticBuyers`
+  // call. Provide this to retrieve the subsequent page.
+  //
+  // When paginating, all other parameters provided to `ListProgrammaticBuyers`
+  // 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 `ListProgrammaticBuyersRequest` containing matching
+// `ProgrammaticBuyer` objects.
+message ListProgrammaticBuyersResponse {
+  // The `ProgrammaticBuyer` objects from the specified network.
+  repeated ProgrammaticBuyer programmatic_buyers = 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 `ProgrammaticBuyer` objects.
+  // 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
+  // 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;
+}