@google-ads/admanager 0.1.0

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

@@ -0,0 +1,209 @@
+// Copyright 2024 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/applied_label.proto";
+import "google/ads/admanager/v1/custom_field_value.proto";
+import "google/ads/admanager/v1/order_enums.proto";
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/protobuf/timestamp.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 = "OrderMessagesProto";
+option java_package = "com.google.ads.admanager.v1";
+option php_namespace = "Google\\Ads\\AdManager\\V1";
+option ruby_package = "Google::Ads::AdManager::V1";
+
+// The `Order` resource.
+message Order {
+  option (google.api.resource) = {
+    type: "admanager.googleapis.com/Order"
+    pattern: "networks/{network_code}/orders/{order}"
+    plural: "orders"
+    singular: "order"
+  };
+
+  // Identifier. The resource name of the `Order`.
+  // Format: `networks/{network_code}/orders/{order_id}`
+  string name = 1 [(google.api.field_behavior) = IDENTIFIER];
+
+  // Output only. Order ID.
+  int64 order_id = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Required. The display name of the Order.  This value has a maximum length
+  // of 255 characters.
+  string display_name = 2 [(google.api.field_behavior) = REQUIRED];
+
+  // Optional. Specifies whether or not the Order is a programmatic order.
+  bool programmatic = 3 [(google.api.field_behavior) = OPTIONAL];
+
+  // Required. The resource name of the User responsible for trafficking the
+  // Order. Format: "networks/{network_code}/users/{user_id}"
+  string trafficker = 23 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = { type: "admanager.googleapis.com/User" }
+  ];
+
+  // Optional. The resource names of Contacts from the advertiser of this Order.
+  // Format: "networks/{network_code}/contacts/{contact_id}"
+  repeated string advertiser_contacts = 5 [
+    (google.api.field_behavior) = OPTIONAL,
+    (google.api.resource_reference) = {
+      type: "admanager.googleapis.com/Contact"
+    }
+  ];
+
+  // Required. The resource name of the Company, which is of type
+  // Company.Type.ADVERTISER, to which this order belongs. Format:
+  // "networks/{network_code}/companies/{company_id}"
+  string advertiser = 6 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "admanager.googleapis.com/Company"
+    }
+  ];
+
+  // Optional. The resource names of Contacts from the advertising Agency of
+  // this Order. Format: "networks/{network_code}/contacts/{contact_id}"
+  repeated string agency_contacts = 7 [
+    (google.api.field_behavior) = OPTIONAL,
+    (google.api.resource_reference) = {
+      type: "admanager.googleapis.com/Contact"
+    }
+  ];
+
+  // Optional. The resource name of the Company, which is of type
+  // Company.Type.AGENCY, with which this order is associated. Format:
+  // "networks/{network_code}/companies/{company_id}"
+  string agency = 8 [
+    (google.api.field_behavior) = OPTIONAL,
+    (google.api.resource_reference) = {
+      type: "admanager.googleapis.com/Company"
+    }
+  ];
+
+  // Optional. The resource names of Teams directly applied to this Order.
+  // Format: "networks/{network_code}/teams/{team_id}"
+  repeated string applied_teams = 9 [
+    (google.api.field_behavior) = OPTIONAL,
+    (google.api.resource_reference) = { type: "admanager.googleapis.com/Team" }
+  ];
+
+  // Output only. The resource names of Teams applied to this Order including
+  // inherited values. Format: "networks/{network_code}/teams/{team_id}"
+  repeated string effective_teams = 28 [
+    (google.api.field_behavior) = OUTPUT_ONLY,
+    (google.api.resource_reference) = { type: "admanager.googleapis.com/Team" }
+  ];
+
+  // Output only. The resource name of the User who created the Order on behalf
+  // of the advertiser. This value is assigned by Google. Format:
+  // "networks/{network_code}/users/{user_id}"
+  string creator = 10 [
+    (google.api.field_behavior) = OUTPUT_ONLY,
+    (google.api.resource_reference) = { type: "admanager.googleapis.com/User" }
+  ];
+
+  // Output only. The ISO 4217 3-letter currency code for the currency used by
+  // the Order. This value is the network's currency code.
+  string currency_code = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The instant at which the Order and its associated line items
+  // are eligible to begin serving. This attribute is derived from the line item
+  // of the order that has the earliest LineItem.start_time.
+  google.protobuf.Timestamp start_time = 19
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The instant at which the Order and its associated line items
+  // stop being served. This attribute is derived from the line item of the
+  // order that has the latest LineItem.end_time.
+  google.protobuf.Timestamp end_time = 12
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Indicates whether or not this Order has an end time.
+  bool unlimited_end_time = 45 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Optional. An arbitrary ID to associate to the Order, which can be used as a
+  // key to an external system.
+  int64 external_order_id = 13 [(google.api.field_behavior) = OPTIONAL];
+
+  // Output only. The archival status of the Order.
+  bool archived = 14 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The application which modified this order. This attribute is
+  // assigned by Google.
+  string last_modified_by_app = 15 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The instant this Order was last modified.
+  google.protobuf.Timestamp update_time = 16
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Optional. Provides any additional notes that may annotate the Order. This
+  // attribute has a maximum length of 65,535 characters.
+  string notes = 17 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. The purchase order number for the Order. This value has a maximum
+  // length of 63 characters.
+  string po_number = 18 [(google.api.field_behavior) = OPTIONAL];
+
+  // Output only. The status of the Order.
+  OrderStatusEnum.OrderStatus status = 20
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Optional. The resource name of the User responsible for the sales of the
+  // Order. Format: "networks/{network_code}/users/{user_id}"
+  string salesperson = 21 [
+    (google.api.field_behavior) = OPTIONAL,
+    (google.api.resource_reference) = { type: "admanager.googleapis.com/User" }
+  ];
+
+  // Optional. Unordered list. The resource names of the secondary salespeople
+  // associated with the order. Format:
+  // "networks/{network_code}/users/{user_id}"
+  repeated string secondary_salespeople = 22 [
+    (google.api.field_behavior) = OPTIONAL,
+    (google.api.field_behavior) = UNORDERED_LIST,
+    (google.api.resource_reference) = { type: "admanager.googleapis.com/User" }
+  ];
+
+  // Optional. Unordered list. The resource names of the secondary traffickers
+  // associated with the order. Format:
+  // "networks/{network_code}/users/{user_id}"
+  repeated string secondary_traffickers = 24 [
+    (google.api.field_behavior) = OPTIONAL,
+    (google.api.field_behavior) = UNORDERED_LIST,
+    (google.api.resource_reference) = { type: "admanager.googleapis.com/User" }
+  ];
+
+  // Optional. The set of labels applied directly to this order.
+  repeated AppliedLabel applied_labels = 25
+      [(google.api.field_behavior) = OPTIONAL];
+
+  // Output only. Contains the set of labels applied directly to the order as
+  // well as those inherited from the company that owns the order. If a label
+  // has been negated, only the negated label is returned. This field is
+  // assigned by Google.
+  repeated AppliedLabel effective_applied_labels = 26
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Optional. The set of custom field values to this order.
+  repeated CustomFieldValue custom_field_values = 38
+      [(google.api.field_behavior) = OPTIONAL];
+}

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

@@ -0,0 +1,129 @@
+// Copyright 2024 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/order_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 = "OrderServiceProto";
+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 `Order` objects.
+service OrderService {
+  option (google.api.default_host) = "admanager.googleapis.com";
+
+  // API to retrieve an Order object.
+  rpc GetOrder(GetOrderRequest) returns (Order) {
+    option (google.api.http) = {
+      get: "/v1/{name=networks/*/orders/*}"
+    };
+    option (google.api.method_signature) = "name";
+  }
+
+  // API to retrieve a list of `Order` objects.
+  //
+  // Fields used for literal matching in filter string:
+  // * `order_id`
+  // * `display_name`
+  // * `external_order_id`
+  rpc ListOrders(ListOrdersRequest) returns (ListOrdersResponse) {
+    option (google.api.http) = {
+      get: "/v1/{parent=networks/*}/orders"
+    };
+    option (google.api.method_signature) = "parent";
+  }
+}
+
+// Request object for `GetOrder` method.
+message GetOrderRequest {
+  // Required. The resource name of the Order.
+  // Format: `networks/{network_code}/orders/{order_id}`
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = { type: "admanager.googleapis.com/Order" }
+  ];
+}
+
+// Request object for `ListOrders` method.
+message ListOrdersRequest {
+  // Required. The parent, which owns this collection of Orders.
+  // 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 `Orders` to return. The service may return
+  // fewer than this value. If unspecified, at most 50 `Orders` 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 `ListOrders` call.
+  // Provide this to retrieve the subsequent page.
+  //
+  // When paginating, all other parameters provided to `ListOrders` 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 `ListOrdersRequest` containing matching `Order`
+// resources.
+message ListOrdersResponse {
+  // The `Order` from the specified network.
+  repeated Order orders = 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 `Orders`.
+  // 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;
+}

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

@@ -0,0 +1,44 @@
+// Copyright 2024 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 = "PlacementEnumsProto";
+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
+// [PlacementStatus][google.ads.admanager.v1.PlacementStatusEnum.PlacementStatus]
+message PlacementStatusEnum {
+  // Status of the placement.
+  enum PlacementStatus {
+    // Not specified value.
+    PLACEMENT_STATUS_UNSPECIFIED = 0;
+
+    // Stats are collected, user-visible.
+    ACTIVE = 1;
+
+    // No stats collected, not user-visible.
+    INACTIVE = 2;
+
+    // No stats collected, user-visible.
+    ARCHIVED = 3;
+  }
+}

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

@@ -0,0 +1,77 @@
+// Copyright 2024 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/placement_enums.proto";
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/protobuf/timestamp.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 = "PlacementMessagesProto";
+option java_package = "com.google.ads.admanager.v1";
+option php_namespace = "Google\\Ads\\AdManager\\V1";
+option ruby_package = "Google::Ads::AdManager::V1";
+
+// The `Placement` resource.
+message Placement {
+  option (google.api.resource) = {
+    type: "admanager.googleapis.com/Placement"
+    pattern: "networks/{network_code}/placements/{placement}"
+    plural: "placements"
+    singular: "placement"
+  };
+
+  // Identifier. The resource name of the `Placement`.
+  // Format: `networks/{network_code}/placements/{placement_id}`
+  string name = 1 [(google.api.field_behavior) = IDENTIFIER];
+
+  // Output only. `Placement` ID.
+  int64 placement_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Required. The display name of the placement. Its maximum length is 255
+  // characters.
+  string display_name = 3 [(google.api.field_behavior) = REQUIRED];
+
+  // Optional. A description of the Placement. This value is optional and its
+  // maximum length is 65,535 characters.
+  string description = 4 [(google.api.field_behavior) = OPTIONAL];
+
+  // Output only. A string used to uniquely identify the Placement for purposes
+  // of serving the ad. This attribute is read-only and is assigned by Google
+  // when a placement is created.
+  string placement_code = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The status of the Placement. This attribute is read-only.
+  PlacementStatusEnum.PlacementStatus status = 6
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Optional. The resource names of AdUnits that constitute the Placement.
+  // Format: "networks/{network_code}/adUnits/{ad_unit_id}"
+  repeated string targeted_ad_units = 7 [
+    (google.api.field_behavior) = OPTIONAL,
+    (google.api.resource_reference) = {
+      type: "admanager.googleapis.com/AdUnit"
+    }
+  ];
+
+  // Output only. The instant this Placement was last modified.
+  google.protobuf.Timestamp update_time = 9
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+}

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

@@ -0,0 +1,126 @@
+// Copyright 2024 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/placement_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 = "PlacementServiceProto";
+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 `Placement` objects.
+service PlacementService {
+  option (google.api.default_host) = "admanager.googleapis.com";
+
+  // API to retrieve a `Placement` object.
+  rpc GetPlacement(GetPlacementRequest) returns (Placement) {
+    option (google.api.http) = {
+      get: "/v1/{name=networks/*/placements/*}"
+    };
+    option (google.api.method_signature) = "name";
+  }
+
+  // API to retrieve a list of `Placement` objects.
+  rpc ListPlacements(ListPlacementsRequest) returns (ListPlacementsResponse) {
+    option (google.api.http) = {
+      get: "/v1/{parent=networks/*}/placements"
+    };
+    option (google.api.method_signature) = "parent";
+  }
+}
+
+// Request object for `GetPlacement` method.
+message GetPlacementRequest {
+  // Required. The resource name of the Placement.
+  // Format: `networks/{network_code}/placements/{placement_id}`
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "admanager.googleapis.com/Placement"
+    }
+  ];
+}
+
+// Request object for `ListPlacements` method.
+message ListPlacementsRequest {
+  // Required. The parent, which owns this collection of Placements.
+  // 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 `Placements` to return. The service may
+  // return fewer than this value. If unspecified, at most 50 `Placements` 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 `ListPlacements` call.
+  // Provide this to retrieve the subsequent page.
+  //
+  // When paginating, all other parameters provided to `ListPlacements` 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 `ListPlacementsRequest` containing matching `Placement`
+// objects.
+message ListPlacementsResponse {
+  // The `Placement` objects from the specified network.
+  repeated Placement placements = 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 `Placement` 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;
+}