@google-ads/admanager 0.9.0 → 0.11.0

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

@@ -37,7 +37,7 @@ service AudienceSegmentService {
       "https://www.googleapis.com/auth/admanager,"
       "https://www.googleapis.com/auth/admanager.readonly";
 
-  // API to retrieve an `AudienceSegment` object.
+  // Retrieves an `AudienceSegment` object.
   rpc GetAudienceSegment(GetAudienceSegmentRequest) returns (AudienceSegment) {
     option (google.api.http) = {
       get: "/v1/{name=networks/*/audienceSegments/*}"
@@ -45,7 +45,7 @@ service AudienceSegmentService {
     option (google.api.method_signature) = "name";
   }
 
-  // API to retrieve a list of `AudienceSegment` objects.
+  // Lists `AudienceSegment` objects.
   rpc ListAudienceSegments(ListAudienceSegmentsRequest)
       returns (ListAudienceSegmentsResponse) {
     option (google.api.http) = {
@@ -53,6 +53,56 @@ service AudienceSegmentService {
     };
     option (google.api.method_signature) = "parent";
   }
+
+  // Activates `AudienceSegment` objects.
+  rpc BatchActivateAudienceSegments(BatchActivateAudienceSegmentsRequest)
+      returns (BatchActivateAudienceSegmentsResponse) {
+    option (google.api.http) = {
+      post: "/v1/{parent=networks/*}/audienceSegments:batchActivate"
+      body: "*"
+    };
+    option (google.api.method_signature) = "parent,names";
+  }
+
+  // Deactivates `AudienceSegment` objects.
+  rpc BatchDeactivateAudienceSegments(BatchDeactivateAudienceSegmentsRequest)
+      returns (BatchDeactivateAudienceSegmentsResponse) {
+    option (google.api.http) = {
+      post: "/v1/{parent=networks/*}/audienceSegments:batchDeactivate"
+      body: "*"
+    };
+    option (google.api.method_signature) = "parent,names";
+  }
+
+  // Approves `AudienceSegment` objects.
+  rpc BatchApproveAudienceSegments(BatchApproveAudienceSegmentsRequest)
+      returns (BatchApproveAudienceSegmentsResponse) {
+    option (google.api.http) = {
+      post: "/v1/{parent=networks/*}/audienceSegments:batchApprove"
+      body: "*"
+    };
+    option (google.api.method_signature) = "parent,names";
+  }
+
+  // Rejects `AudienceSegment` objects.
+  rpc BatchRejectAudienceSegments(BatchRejectAudienceSegmentsRequest)
+      returns (BatchRejectAudienceSegmentsResponse) {
+    option (google.api.http) = {
+      post: "/v1/{parent=networks/*}/audienceSegments:batchReject"
+      body: "*"
+    };
+    option (google.api.method_signature) = "parent,names";
+  }
+
+  // Populates `AudienceSegment` objects.
+  rpc BatchPopulateAudienceSegments(BatchPopulateAudienceSegmentsRequest)
+      returns (BatchPopulateAudienceSegmentsResponse) {
+    option (google.api.http) = {
+      post: "/v1/{parent=networks/*}/audienceSegments:batchPopulate"
+      body: "*"
+    };
+    option (google.api.method_signature) = "parent,names";
+  }
 }
 
 // Request object for `GetAudienceSegment` method.
@@ -95,10 +145,23 @@ message ListAudienceSegmentsRequest {
   //  See syntax details at
   //  https://developers.google.com/ad-manager/api/beta/filters
   //
-  // <b>Filterable fields:</b>
-  // <ul style="list-style-type:none">
-  //   <li><code>displayName</code></li>
-  // </ul>
+  // **Filterable fields:**
+  //
+  // * `adIdSize`
+  // * `categoryIds`
+  // * `dataProviderDisplayName`
+  // * `displayName`
+  // * `idfaSize`
+  // * `mobileWebSize`
+  // * `ppidSize`
+  // * `segmentType`
+  // * `sharedId`
+  // * `size`
+  // * `status`
+  // * `thirdPartyAudienceSegment.approvalStatus`
+  // * `thirdPartyAudienceSegment.cost`
+  // * `thirdPartyAudienceSegment.endTime`
+  // * `thirdPartyAudienceSegment.startTime`
   string filter = 4 [(google.api.field_behavior) = OPTIONAL];
 
   // Optional. Expression to specify sorting order.
@@ -133,3 +196,133 @@ message ListAudienceSegmentsResponse {
   // https://developers.google.com/ad-manager/api/beta/field-masks
   int32 total_size = 3;
 }
+
+// Request message for `BatchActivateAudienceSegments` method.
+message BatchActivateAudienceSegmentsRequest {
+  // Required. Format: `networks/{network_code}`
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "admanager.googleapis.com/Network"
+    }
+  ];
+
+  // Required. Resource names for the AudienceSegments.
+  // Format: `networks/{network_code}/audienceSegments/{audience_segment_id}`
+  repeated string names = 2 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "admanager.googleapis.com/AudienceSegment"
+    }
+  ];
+}
+
+// Response message for `BatchActivateAudienceSegments` method.
+message BatchActivateAudienceSegmentsResponse {
+  // Number of audience segments activated.
+  int64 change_count = 1;
+}
+
+// Request message for `BatchDeactivateAudienceSegments` method.
+message BatchDeactivateAudienceSegmentsRequest {
+  // Required. Format: `networks/{network_code}`
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "admanager.googleapis.com/Network"
+    }
+  ];
+
+  // Required. Resource names for the AudienceSegments.
+  // Format: `networks/{network_code}/audienceSegments/{audience_segment_id}`
+  repeated string names = 2 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "admanager.googleapis.com/AudienceSegment"
+    }
+  ];
+}
+
+// Response message for `BatchDeactivateAudienceSegments` method.
+message BatchDeactivateAudienceSegmentsResponse {
+  // Number of audience segments deactivated.
+  int64 change_count = 1;
+}
+
+// Request message for `BatchApproveAudienceSegments` method.
+message BatchApproveAudienceSegmentsRequest {
+  // Required. Format: `networks/{network_code}`
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "admanager.googleapis.com/Network"
+    }
+  ];
+
+  // Required. Resource names for the AudienceSegments.
+  // Format: `networks/{network_code}/audienceSegments/{audience_segment_id}`
+  repeated string names = 2 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "admanager.googleapis.com/AudienceSegment"
+    }
+  ];
+}
+
+// Response message for `BatchApproveAudienceSegments` method.
+message BatchApproveAudienceSegmentsResponse {
+  // Number of audience segments approved.
+  int64 change_count = 1;
+}
+
+// Request message for `BatchRejectAudienceSegments` method.
+message BatchRejectAudienceSegmentsRequest {
+  // Required. Format: `networks/{network_code}`
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "admanager.googleapis.com/Network"
+    }
+  ];
+
+  // Required. Resource names for the AudienceSegments.
+  // Format: `networks/{network_code}/audienceSegments/{audience_segment_id}`
+  repeated string names = 2 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "admanager.googleapis.com/AudienceSegment"
+    }
+  ];
+}
+
+// Response message for `BatchRejectAudienceSegments` method.
+message BatchRejectAudienceSegmentsResponse {
+  // Number of audience segments rejected.
+  int64 change_count = 1;
+}
+
+// Request message for `BatchPopulateAudienceSegments` method.
+message BatchPopulateAudienceSegmentsRequest {
+  // Required. Format: `networks/{network_code}`
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "admanager.googleapis.com/Network"
+    }
+  ];
+
+  // Required. Resource names for the AudienceSegments.
+  // Format: `networks/{network_code}/audienceSegments/{audience_segment_id}`
+  repeated string names = 2 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "admanager.googleapis.com/AudienceSegment"
+    }
+  ];
+}
+
+// Response message for `BatchPopulateAudienceSegments` method.
+message BatchPopulateAudienceSegmentsResponse {
+  // Number of audience segments populated.
+  int64 change_count = 1;
+}

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

@@ -95,11 +95,10 @@ message ListBandwidthGroupsRequest {
   //  See syntax details at
   //  https://developers.google.com/ad-manager/api/beta/filters
   //
-  // <b>Filterable fields:</b>
-  // <ul style="list-style-type:none">
-  //   <li><code>displayName</code></li>
-  //   <li><code>name</code></li>
-  // </ul>
+  // **Filterable fields:**
+  //
+  // * `displayName`
+  // * `name`
   string filter = 4 [(google.api.field_behavior) = OPTIONAL];
 
   // Optional. Expression to specify sorting order.

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

@@ -95,11 +95,10 @@ message ListBrowserLanguagesRequest {
   //  See syntax details at
   //  https://developers.google.com/ad-manager/api/beta/filters
   //
-  // <b>Filterable fields:</b>
-  // <ul style="list-style-type:none">
-  //   <li><code>displayName</code></li>
-  //   <li><code>name</code></li>
-  // </ul>
+  // **Filterable fields:**
+  //
+  // * `displayName`
+  // * `name`
   string filter = 4 [(google.api.field_behavior) = OPTIONAL];
 
   // Optional. Expression to specify sorting order.

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

@@ -94,13 +94,12 @@ message ListBrowsersRequest {
   //  See syntax details at
   //  https://developers.google.com/ad-manager/api/beta/filters
   //
-  // <b>Filterable fields:</b>
-  // <ul style="list-style-type:none">
-  //   <li><code>displayName</code></li>
-  //   <li><code>majorVersion</code></li>
-  //   <li><code>minorVersion</code></li>
-  //   <li><code>name</code></li>
-  // </ul>
+  // **Filterable fields:**
+  //
+  // * `displayName`
+  // * `majorVersion`
+  // * `minorVersion`
+  // * `name`
   string filter = 4 [(google.api.field_behavior) = OPTIONAL];
 
   // Optional. Expression to specify sorting order.

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

@@ -153,14 +153,13 @@ message ListCdnConfigsRequest {
   //  See syntax details at
   //  https://developers.google.com/ad-manager/api/beta/filters
   //
-  // <b>Filterable fields:</b>
-  // <ul style="list-style-type:none">
-  //   <li><code>cdnConfigStatus</code></li>
-  //   <li><code>cdnConfigType</code></li>
-  //   <li><code>displayName</code></li>
-  //   <li><code>name</code></li>
-  //   <li><code>sourceContentConfig.ingestSettings.urlPrefix</code></li>
-  // </ul>
+  // **Filterable fields:**
+  //
+  // * `cdnConfigStatus`
+  // * `cdnConfigType`
+  // * `displayName`
+  // * `name`
+  // * `sourceContentConfig.ingestSettings.urlPrefix`
   string filter = 4 [(google.api.field_behavior) = OPTIONAL];
 
   // Optional. Expression to specify sorting order.

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

@@ -16,6 +16,7 @@ syntax = "proto3";
 
 package google.ads.admanager.v1;
 
+import "google/ads/admanager/v1/mcm_enums.proto";
 import "google/api/field_behavior.proto";
 import "google/api/resource.proto";
 
@@ -40,4 +41,102 @@ message ChildPublisher {
   // [ChildPublisher][google.ads.admanager.v1.ChildPublisher]. Format:
   // `networks/{network_code}/childPublishers/{child_publisher_id}`
   string name = 1 [(google.api.field_behavior) = IDENTIFIER];
+
+  // Required. The display name of the
+  // [ChildPublisher][google.ads.admanager.v1.ChildPublisher].
+  optional string display_name = 3 [(google.api.field_behavior) = REQUIRED];
+
+  // Required. The email for the
+  // [ChildPublisher][google.ads.admanager.v1.ChildPublisher].
+  optional string email = 4 [(google.api.field_behavior) = REQUIRED];
+
+  // Immutable. The resource name of the
+  // [ChildPublisher][google.ads.admanager.v1.ChildPublisher]'s Ad Manager
+  // network.
+  //
+  // Format: `networks/{network_code}`
+  optional string child_network = 5 [
+    (google.api.field_behavior) = IMMUTABLE,
+    (google.api.resource_reference) = {
+      type: "admanager.googleapis.com/Network"
+    }
+  ];
+
+  // Required. The type of delegation for the
+  // [ChildPublisher][google.ads.admanager.v1.ChildPublisher].
+  //
+  // This attribute is immutable while the relationship is active.
+  optional DelegationTypeEnum.DelegationType delegation_type = 9
+      [(google.api.field_behavior) = REQUIRED];
+
+  // Optional. The revenue share that the parent publisher will receive in
+  // millipercent. For example, 15000 millipercent is 15%.
+  //
+  // This attribute is only settable for Manage Account
+  // [ChildPublisher][google.ads.admanager.v1.ChildPublisher]s of non-reseller
+  // parent publishers. Otherwise, it is read-only and always 100%.
+  //
+  // Additionally, this attribute is immutable while the relationship is active.
+  optional int64 parent_revenue_share_millipercent = 10
+      [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. The seller ID for the
+  // [ChildPublisher][google.ads.admanager.v1.ChildPublisher], as specified in
+  // the parent publisher's sellers.json file.
+  //
+  // This attribute is only applicable to Manage Inventory
+  // [ChildPublisher][google.ads.admanager.v1.ChildPublisher]s.
+  optional string seller_id = 11 [(google.api.field_behavior) = OPTIONAL];
+
+  // Output only. The overall onboarding readiness of the
+  // [ChildPublisher][google.ads.admanager.v1.ChildPublisher].
+  //
+  // This status is correlated with ad serving, but does not include site-level
+  // approval information.
+  optional McmReadinessStatusEnum.McmReadinessStatus readiness_status = 12
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The status of the invitation request to the
+  // [ChildPublisher][google.ads.admanager.v1.ChildPublisher].
+  optional DelegationInvitationStatusEnum.DelegationInvitationStatus
+      invitation_status = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The approval status of the
+  // [ChildPublisher][google.ads.admanager.v1.ChildPublisher].
+  optional DelegationApprovalStatusEnum.DelegationApprovalStatus
+      approval_status = 15 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The status of the
+  // [ChildPublisher][google.ads.admanager.v1.ChildPublisher]'s identity
+  // verification.
+  optional ChildPublisherIdentityVerificationStatusEnum
+      .ChildPublisherIdentityVerificationStatus identity_verification_status =
+      17 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The status of the
+  // [ChildPublisher][google.ads.admanager.v1.ChildPublisher]'s address
+  // verification (i.e., mail PIN).
+  optional ChildPublisherAddressVerificationStatusEnum
+      .ChildPublisherAddressVerificationStatus address_verification_status = 19
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The pending onboarding tasks that must be completed by the
+  // child publisher before Google's policy compliance (i.e.
+  // [DelegationApprovalStatus.PENDING_GOOGLE_APPROVAL][]) can be verified.
+  repeated ChildPublisherOnboardingTaskEnum.ChildPublisherOnboardingTask
+      pending_onboarding_tasks = 22 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The account status of the
+  // [ChildPublisher][google.ads.admanager.v1.ChildPublisher].
+  optional DelegationAccountStatusEnum.DelegationAccountStatus account_status =
+      26 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Provides the approved revenue share that the parent publisher
+  // will receive in millipercent. For example, 15000 millipercent is 15%.
+  //
+  // This attribute is only set for Manage Account
+  // [ChildPublisher][google.ads.admanager.v1.ChildPublisher]s of non-reseller
+  // parent publishers.
+  optional int64 approved_manage_account_revenue_share_millipercent = 29
+      [(google.api.field_behavior) = OUTPUT_ONLY];
 }