@google-ads/admanager 0.4.1 → 0.5.1

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

@@ -61,10 +61,12 @@ message Order {
     (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}"
+  // Optional. Unordered list. 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.field_behavior) = UNORDERED_LIST,
     (google.api.resource_reference) = {
       type: "admanager.googleapis.com/Contact"
     }
@@ -114,8 +116,7 @@ message Order {
   ];
 
   // 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}"
+  // of the advertiser. Format: "networks/{network_code}/users/{user_id}"
   optional string creator = 10 [
     (google.api.field_behavior) = OUTPUT_ONLY,
     (google.api.resource_reference) = { type: "admanager.googleapis.com/User" }
@@ -126,15 +127,15 @@ message Order {
   optional 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.
+  // 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`.
   optional 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.
+  // 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`.
   optional google.protobuf.Timestamp end_time = 12
       [(google.api.field_behavior) = OUTPUT_ONLY];
 

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

@@ -81,8 +81,8 @@ message ListOrdersRequest {
 
   // 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.
+  // 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 `ListOrders` call.
@@ -120,7 +120,7 @@ message ListOrdersResponse {
   // 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/placement_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";
@@ -51,6 +52,74 @@ service PlacementService {
     };
     option (google.api.method_signature) = "parent";
   }
+
+  // API to create an `Placement` object.
+  rpc CreatePlacement(CreatePlacementRequest) returns (Placement) {
+    option (google.api.http) = {
+      post: "/v1/{parent=networks/*}/placements"
+      body: "placement"
+    };
+    option (google.api.method_signature) = "parent,placement";
+  }
+
+  // API to update an `Placement` object.
+  rpc UpdatePlacement(UpdatePlacementRequest) returns (Placement) {
+    option (google.api.http) = {
+      patch: "/v1/{placement.name=networks/*/placements/*}"
+      body: "placement"
+    };
+    option (google.api.method_signature) = "placement,update_mask";
+  }
+
+  // API to batch create `Placement` objects.
+  rpc BatchCreatePlacements(BatchCreatePlacementsRequest)
+      returns (BatchCreatePlacementsResponse) {
+    option (google.api.http) = {
+      post: "/v1/{parent=networks/*}/placements:batchCreate"
+      body: "*"
+    };
+    option (google.api.method_signature) = "parent,requests";
+  }
+
+  // API to batch update `Placement` objects.
+  rpc BatchUpdatePlacements(BatchUpdatePlacementsRequest)
+      returns (BatchUpdatePlacementsResponse) {
+    option (google.api.http) = {
+      post: "/v1/{parent=networks/*}/placements:batchUpdate"
+      body: "*"
+    };
+    option (google.api.method_signature) = "parent,requests";
+  }
+
+  // Activates a list of `Placement` objects.
+  rpc BatchActivatePlacements(BatchActivatePlacementsRequest)
+      returns (BatchActivatePlacementsResponse) {
+    option (google.api.http) = {
+      post: "/v1/{parent=networks/*}/placements:batchActivate"
+      body: "*"
+    };
+    option (google.api.method_signature) = "parent,names";
+  }
+
+  // Deactivates a list of `Placement` objects.
+  rpc BatchDeactivatePlacements(BatchDeactivatePlacementsRequest)
+      returns (BatchDeactivatePlacementsResponse) {
+    option (google.api.http) = {
+      post: "/v1/{parent=networks/*}/placements:batchDeactivate"
+      body: "*"
+    };
+    option (google.api.method_signature) = "parent,names";
+  }
+
+  // Archives a list of `Placement` objects.
+  rpc BatchArchivePlacements(BatchArchivePlacementsRequest)
+      returns (BatchArchivePlacementsResponse) {
+    option (google.api.http) = {
+      post: "/v1/{parent=networks/*}/placements:batchArchive"
+      body: "*"
+    };
+    option (google.api.method_signature) = "parent,names";
+  }
 }
 
 // Request object for `GetPlacement` method.
@@ -78,8 +147,8 @@ message ListPlacementsRequest {
 
   // 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.
+  // 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 `ListPlacements` call.
@@ -117,7 +186,7 @@ message ListPlacementsResponse {
   // 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`.
@@ -126,3 +195,151 @@ message ListPlacementsResponse {
   // https://developers.google.com/ad-manager/api/beta/field-masks
   int32 total_size = 3;
 }
+
+// Request object for `CreatePlacement` method.
+message CreatePlacementRequest {
+  // Required. The parent resource where this `Placement` 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 `Placement` to create.
+  Placement placement = 2 [(google.api.field_behavior) = REQUIRED];
+}
+
+// Request object for `BatchCreatePlacements` method.
+message BatchCreatePlacementsRequest {
+  // Required. The parent resource where the `Placement`s will be created.
+  // Format: `networks/{network_code}`
+  // The parent field in the CreatePlacementRequest messages match this
+  // field.
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "admanager.googleapis.com/Network"
+    }
+  ];
+
+  // Required. The `Placement` objects to create.
+  // A maximum of 100 objects can be created in a batch.
+  repeated CreatePlacementRequest requests = 2
+      [(google.api.field_behavior) = REQUIRED];
+}
+
+// Response object for `BatchCreatePlacements` method.
+message BatchCreatePlacementsResponse {
+  // The `Placement` objects created.
+  repeated Placement placements = 1;
+}
+
+// Request object for `UpdatePlacement` method.
+message UpdatePlacementRequest {
+  // Required. The `Placement` to update.
+  //
+  // The `Placement`'s name is used to identify the `Placement` to
+  // update. Format:
+  // `networks/{network_code}/placements/{placement_id}`
+  Placement placement = 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 `BatchUpdatePlacements` method.
+message BatchUpdatePlacementsRequest {
+  // Required. The parent resource where `Placements` will be updated.
+  // Format: `networks/{network_code}`
+  // The parent field in the UpdatePlacementsRequest must match this
+  // field.
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "admanager.googleapis.com/Network"
+    }
+  ];
+
+  // Required. The `Placement` objects to update.
+  // A maximum of 100 objects can be updated in a batch.
+  repeated UpdatePlacementRequest requests = 2
+      [(google.api.field_behavior) = REQUIRED];
+}
+
+// Response object for `BatchUpdatePlacements` method.
+message BatchUpdatePlacementsResponse {
+  // The `Placement` objects updated.
+  repeated Placement placements = 1;
+}
+
+// Request message for `BatchActivatePlacements` method.
+message BatchActivatePlacementsRequest {
+  // Required. Format: `networks/{network_code}`
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "admanager.googleapis.com/Network"
+    }
+  ];
+
+  // Required. The names of the `Placement` objects to activate.
+  // Format: `networks/{network_code}/placements/{placement_id}`
+  repeated string names = 3 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "admanager.googleapis.com/Placement"
+    }
+  ];
+}
+
+// Response object for `BatchActivatePlacements` method.
+message BatchActivatePlacementsResponse {}
+
+// Request message for `BatchDeactivatePlacements` method.
+message BatchDeactivatePlacementsRequest {
+  // Required. Format: `networks/{network_code}`
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "admanager.googleapis.com/Network"
+    }
+  ];
+
+  // Required. The names of the `Placement` objects to deactivate.
+  // Format: `networks/{network_code}/placements/{placement_id}`
+  repeated string names = 3 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "admanager.googleapis.com/Placement"
+    }
+  ];
+}
+
+// Response object for `BatchDeactivatePlacements` method.
+message BatchDeactivatePlacementsResponse {}
+
+// Request message for `BatchArchivePlacements` method.
+message BatchArchivePlacementsRequest {
+  // Required. Format: `networks/{network_code}`
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "admanager.googleapis.com/Network"
+    }
+  ];
+
+  // Required. The names of the `Placement` objects to archive.
+  // Format: `networks/{network_code}/placements/{placement_id}`
+  repeated string names = 3 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "admanager.googleapis.com/Placement"
+    }
+  ];
+}
+
+// Response object for `BatchArchivePlacements` method.
+message BatchArchivePlacementsResponse {}

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

@@ -104,7 +104,7 @@ message ListPrivateAuctionDealsRequest {
   // Optional. The maximum number of `PrivateAuctionDeals` to return. The
   // service may return fewer than this value. If unspecified, at most 50
   // `PrivateAuctionDeals` will be returned. The maximum value is 1000;
-  // values above 1000 will be coerced to 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 `ListPrivateAuctionDeals`
@@ -143,7 +143,7 @@ message ListPrivateAuctionDealsResponse {
   // 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/private_auction_service.proto

@@ -102,7 +102,7 @@ message ListPrivateAuctionsRequest {
   // Optional. The maximum number of `PrivateAuctions` to return. The service
   // may return fewer than this value. If unspecified, at most 50
   // `PrivateAuctions` will be returned. The maximum value is 1000;
-  // values above 1000 will be coerced to 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 `ListPrivateAuctions`
@@ -141,7 +141,7 @@ message ListPrivateAuctionsResponse {
   // 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/programmatic_buyer_service.proto

@@ -120,7 +120,7 @@ message ListProgrammaticBuyersResponse {
   // 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`.