@google-ads/admanager 0.4.1 → 0.5.1

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

@@ -16,6 +16,7 @@ syntax = "proto3";
 
 package google.ads.admanager.v1;
 
+import "google/ads/admanager/v1/report_definition.proto";
 import "google/ads/admanager/v1/report_messages.proto";
 import "google/api/annotations.proto";
 import "google/api/client.proto";
@@ -74,7 +75,7 @@ service ReportService {
   }
 
   // Initiates the execution of an existing report asynchronously. Users can
-  // get the report by polling this operation via
+  // get the report by polling this operation using
   // `OperationsService.GetOperation`.
   // Poll every 5 seconds initially, with an exponential
   // backoff. Once a report is complete, the operation will contain a
@@ -162,8 +163,8 @@ message ListReportsRequest {
 
   // Optional. The maximum number of `Reports` to return. The service may return
   // fewer than this value. If unspecified, at most 50 `Reports` 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 `ListReports` call.
@@ -201,7 +202,7 @@ message ListReportsResponse {
   // 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`.
@@ -245,7 +246,8 @@ message FetchReportResultRowsRequest {
 
   // Optional. The maximum number of rows to return. The service may return
   // fewer than this value. If unspecified, at most 1,000 rows will be returned.
-  // The maximum value is 10,000; values above 10,000 will be reduced to 10,000.
+  // The maximum value is 10,000; values greater than 10,000 will be reduced to
+  // 10,000.
   int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
 
   // Optional. A page token, received from a previous `FetchReportResultRows`
@@ -256,7 +258,7 @@ message FetchReportResultRowsRequest {
 // The response message for the fetch report result rows endpoint.
 message FetchReportResultRowsResponse {
   // Up to `page_size` rows of report data.
-  repeated Report.DataTable.Row rows = 1;
+  repeated ReportDataTable.Row rows = 1;
 
   // The time at which the report was scheduled to run. For non-scheduled
   // reports, this is the time at which the report was requested to be run.
@@ -265,12 +267,12 @@ message FetchReportResultRowsResponse {
   // The computed fixed date ranges this report includes.
   // Only returned with the first page of results (when page_token is not
   // included in the request).
-  repeated Report.DateRange.FixedDateRange date_ranges = 3;
+  repeated ReportDefinition.DateRange.FixedDateRange date_ranges = 3;
 
   // The computed comparison fixed date ranges this report includes.
   // Only returned with the first page of results (when page_token is not
   // included in the request).
-  repeated Report.DateRange.FixedDateRange comparison_date_ranges = 4;
+  repeated ReportDefinition.DateRange.FixedDateRange comparison_date_ranges = 4;
 
   // The total number of rows available from this report. Useful for
   // pagination.

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

@@ -0,0 +1,73 @@
+// 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 = "ReportValueProto";
+option java_package = "com.google.ads.admanager.v1";
+option php_namespace = "Google\\Ads\\AdManager\\V1";
+option ruby_package = "Google::Ads::AdManager::V1";
+
+// Represents a single value in a report.
+message ReportValue {
+  // A list of integer values.
+  message IntList {
+    // The values
+    repeated int64 values = 1;
+  }
+
+  // A list of string values.
+  message StringList {
+    // The values
+    repeated string values = 1;
+  }
+
+  // A list of double values.
+  message DoubleList {
+    // The values
+    repeated double values = 1;
+  }
+
+  // The value of the field, depends on the field's data format.
+  oneof value {
+    // For integer values.
+    int64 int_value = 1;
+
+    // For double values.
+    double double_value = 2;
+
+    // For string values.
+    string string_value = 3;
+
+    // For boolean values.
+    bool bool_value = 4;
+
+    // For lists of integer values.
+    IntList int_list_value = 6;
+
+    // For lists of string values.
+    StringList string_list_value = 7;
+
+    // For lists of double values.
+    DoubleList double_list_value = 9;
+
+    // For bytes values.
+    bytes bytes_value = 8;
+  }
+}

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

@@ -76,7 +76,8 @@ message ListRolesRequest {
 
   // Optional. The maximum number of `Roles` to return. The service may return
   // fewer than this value. If unspecified, at most 50 `Roles` will be returned.
-  // The maximum value is 1000; values above 1000 will be coerced to 1000.
+  // 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 `ListRoles` call.
@@ -113,7 +114,7 @@ message ListRolesResponse {
   // 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/site_enums.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;
+
+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 = "SiteEnumsProto";
+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
+// [SiteDisapprovalReason][google.ads.admanager.v1.SiteDisapprovalReasonEnum.SiteDisapprovalReason]
+message SiteDisapprovalReasonEnum {
+  // The list of possible policy violation types for a Site.
+  enum SiteDisapprovalReason {
+    // Default value. This value is unused.
+    SITE_DISAPPROVAL_REASON_UNSPECIFIED = 0;
+
+    // The site has content that violates policy.
+    CONTENT = 1;
+
+    // Generic error type.
+    OTHER = 2;
+
+    // The parent must be an authorized seller of the child network's inventory.
+    OWNERSHIP = 3;
+  }
+}
+
+// Wrapper message for
+// [SiteApprovalStatus][google.ads.admanager.v1.SiteApprovalStatusEnum.SiteApprovalStatus]
+message SiteApprovalStatusEnum {
+  // Represents the approval status of a site.
+  enum SiteApprovalStatus {
+    // Default value. This value is unused.
+    SITE_APPROVAL_STATUS_UNSPECIFIED = 0;
+
+    // The site has been approved to serve ads.
+    APPROVED = 1;
+
+    // The site has been disapproved from serving ads.
+    DISAPPROVED = 2;
+
+    // The default status with which a site is created.
+    DRAFT = 3;
+
+    // The site has been deactivated and is not serving ads due to dormancy. It
+    // must be resubmitted for approval.
+    REQUIRES_REVIEW = 4;
+
+    // Once the site is submitted for approval, its status changes from draft to
+    // unchecked. It will be reviwed with an estimated turn-around time of 24h.
+    // Such a site cannot serve ads.
+    UNCHECKED = 5;
+  }
+}

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

@@ -0,0 +1,77 @@
+// 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/site_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 = "SiteMessagesProto";
+option java_package = "com.google.ads.admanager.v1";
+option php_namespace = "Google\\Ads\\AdManager\\V1";
+option ruby_package = "Google::Ads::AdManager::V1";
+
+// A Site represents a domain owned or represented by a network. For a parent
+// network managing other networks as part of Multiple Customer Management
+// "Manage Inventory" model, it could be the child's domain.
+message Site {
+  option (google.api.resource) = {
+    type: "admanager.googleapis.com/Site"
+    pattern: "networks/{network_code}/sites/{site}"
+    plural: "sites"
+    singular: "site"
+  };
+
+  // Identifier. The resource name of the `Site`.
+  // Format: `networks/{network_code}/sites/{site_id}`
+  string name = 1 [(google.api.field_behavior) = IDENTIFIER];
+
+  // Required. The URL of the Site.
+  optional string url = 3 [(google.api.field_behavior) = REQUIRED];
+
+  // Optional. The network code of the child if the Site is being managed for an
+  // MCM child network, or null if owned by this network.
+  optional string child_network_code = 4
+      [(google.api.field_behavior) = OPTIONAL];
+
+  // Output only. Status of the review performed on the Site by Google.
+  optional SiteApprovalStatusEnum.SiteApprovalStatus approval_status = 5
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The latest Site approval status change time.
+  optional google.protobuf.Timestamp approval_status_update_time = 6
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Provides reasons for disapproving the Site. It is null when
+  // the Site is not disapproved.
+  repeated DisapprovalReason disapproval_reasons = 7
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
+// Represents the reason for which Google disapproved the Site.
+message DisapprovalReason {
+  // Output only. The type of policy violation found for the Site.
+  optional SiteDisapprovalReasonEnum.SiteDisapprovalReason type = 1
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Additional details for the disapproval of the Site.
+  optional string details = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+}

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

@@ -0,0 +1,295 @@
+// 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/site_messages.proto";
+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";
+option java_multiple_files = true;
+option java_outer_classname = "SiteServiceProto";
+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 `Site` objects.
+service SiteService {
+  option (google.api.default_host) = "admanager.googleapis.com";
+  option (google.api.oauth_scopes) =
+      "https://www.googleapis.com/auth/admanager";
+
+  // API to retrieve a `Site` object.
+  rpc GetSite(GetSiteRequest) returns (Site) {
+    option (google.api.http) = {
+      get: "/v1/{name=networks/*/sites/*}"
+    };
+    option (google.api.method_signature) = "name";
+  }
+
+  // API to retrieve a list of `Site` objects.
+  rpc ListSites(ListSitesRequest) returns (ListSitesResponse) {
+    option (google.api.http) = {
+      get: "/v1/{parent=networks/*}/sites"
+    };
+    option (google.api.method_signature) = "parent";
+  }
+
+  // API to create a `Site` object.
+  rpc CreateSite(CreateSiteRequest) returns (Site) {
+    option (google.api.http) = {
+      post: "/v1/{parent=networks/*}/sites"
+      body: "site"
+    };
+    option (google.api.method_signature) = "parent,site";
+  }
+
+  // API to batch create `Site` objects.
+  rpc BatchCreateSites(BatchCreateSitesRequest)
+      returns (BatchCreateSitesResponse) {
+    option (google.api.http) = {
+      post: "/v1/{parent=networks/*}/sites:batchCreate"
+      body: "*"
+    };
+    option (google.api.method_signature) = "parent,requests";
+  }
+
+  // API to update a `Site` object.
+  rpc UpdateSite(UpdateSiteRequest) returns (Site) {
+    option (google.api.http) = {
+      patch: "/v1/{site.name=networks/*/sites/*}"
+      body: "site"
+    };
+    option (google.api.method_signature) = "site,update_mask";
+  }
+
+  // API to batch update `Site` objects.
+  rpc BatchUpdateSites(BatchUpdateSitesRequest)
+      returns (BatchUpdateSitesResponse) {
+    option (google.api.http) = {
+      post: "/v1/{parent=networks/*}/sites:batchUpdate"
+      body: "*"
+    };
+    option (google.api.method_signature) = "parent,requests";
+  }
+
+  // Deactivates a list of `Site` objects.
+  rpc BatchDeactivateSites(BatchDeactivateSitesRequest)
+      returns (BatchDeactivateSitesResponse) {
+    option (google.api.http) = {
+      post: "/v1/{parent=networks/*}/sites:batchDeactivate"
+      body: "*"
+    };
+    option (google.api.method_signature) = "parent,names";
+  }
+
+  // Submits a list of `Site` objects for approval.
+  rpc BatchSubmitSitesForApproval(BatchSubmitSitesForApprovalRequest)
+      returns (BatchSubmitSitesForApprovalResponse) {
+    option (google.api.http) = {
+      post: "/v1/{parent=networks/*}/sites:batchSubmitForApproval"
+      body: "*"
+    };
+    option (google.api.method_signature) = "parent,names";
+  }
+}
+
+// Request object for `GetSite` method.
+message GetSiteRequest {
+  // Required. The resource name of the Site.
+  // Format: `networks/{network_code}/sites/{site_id}`
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = { type: "admanager.googleapis.com/Site" }
+  ];
+}
+
+// Request object for `ListSites` method.
+message ListSitesRequest {
+  // Required. The parent, which owns this collection of Sites.
+  // 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 `Sites` to return. The service may return
+  // fewer than this value. If unspecified, at most 50 `Sites` 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 `ListSites` call.
+  // Provide this to retrieve the subsequent page.
+  //
+  // When paginating, all other parameters provided to `ListSites` 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 `ListSitesRequest` containing matching `Site` objects.
+message ListSitesResponse {
+  // The `Site` objects from the specified network.
+  repeated Site sites = 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 `Site` 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;
+}
+
+// Request object for `CreateSite` method.
+message CreateSiteRequest {
+  // Required. The parent resource where this `Site` 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 `Site` to create.
+  Site site = 2 [(google.api.field_behavior) = REQUIRED];
+}
+
+// Request object for `BatchCreateSites` method.
+message BatchCreateSitesRequest {
+  // Required. The parent resource where `Sites` will be created.
+  // Format: `networks/{network_code}`
+  // The parent field in the CreateSiteRequest must match this
+  // field.
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "admanager.googleapis.com/Network"
+    }
+  ];
+
+  // Required. The `Site` objects to create.
+  // A maximum of 100 objects can be created in a batch.
+  repeated CreateSiteRequest requests = 2
+      [(google.api.field_behavior) = REQUIRED];
+}
+
+// Response object for `BatchCreateSites` method.
+message BatchCreateSitesResponse {
+  // The `Site` objects created.
+  repeated Site sites = 1;
+}
+
+// Request object for `UpdateSite` method.
+message UpdateSiteRequest {
+  // Required. The `Site` to update.
+  //
+  // The `Site`'s `name` is used to identify the `Site` to update.
+  Site site = 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 `BatchUpdateSites` method.
+message BatchUpdateSitesRequest {
+  // Required. The parent resource where `Sites` will be updated.
+  // Format: `networks/{network_code}`
+  // The parent field in the UpdateSiteRequest must match this
+  // field.
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "admanager.googleapis.com/Network"
+    }
+  ];
+
+  // Required. The `Site` objects to update.
+  // A maximum of 100 objects can be updated in a batch.
+  repeated UpdateSiteRequest requests = 2
+      [(google.api.field_behavior) = REQUIRED];
+}
+
+// Response object for `BatchUpdateSites` method.
+message BatchUpdateSitesResponse {
+  // The `Site` objects updated.
+  repeated Site sites = 1;
+}
+
+// Request message for `BatchDeactivateSites` method.
+message BatchDeactivateSitesRequest {
+  // Required. Format: `networks/{network_code}`
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "admanager.googleapis.com/Network"
+    }
+  ];
+
+  // Required. The resource names of the `Site` objects to deactivate.
+  repeated string names = 2 [(google.api.field_behavior) = REQUIRED];
+}
+
+// Response object for `BatchDeactivateSites` method.
+message BatchDeactivateSitesResponse {}
+
+// Request message for `BatchSubmitSitesForApproval` method.
+message BatchSubmitSitesForApprovalRequest {
+  // Required. Format: `networks/{network_code}`
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "admanager.googleapis.com/Network"
+    }
+  ];
+
+  // Required. The resource names of the `Site` objects to submit for approval.
+  repeated string names = 2 [(google.api.field_behavior) = REQUIRED];
+}
+
+// Response object for `BatchSubmitSitesForApproval` method.
+message BatchSubmitSitesForApprovalResponse {}