feat: Add Ad Manager REST API

PiperOrigin-RevId: 617873969

google/ads/admanager/v1/ad_partner_declaration.proto

@@ -0,0 +1,57 @@
+// Copyright 2023 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/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 = "AdPartnerDeclarationProto";
+option java_package = "com.google.ads.admanager.v1";
+option objc_class_prefix = "GAA";
+option php_namespace = "Google\\Ads\\AdManager\\V1";
+
+// Represents a set of declarations about what (if any) ad partners
+// are associated with a given creative. This can be set at the network level,
+// as a default for all creatives, or overridden for a particular creative.
+message AdPartnerDeclaration {
+  // They type of declaration.
+  DeclarationTypeEnum.DeclarationType type = 1;
+
+  // The resource names of AdPartners being declared.
+  // Format: "networks/{network_code}/adPartners/{ad_partner_id}"
+  repeated string ad_partners = 2 [(google.api.resource_reference) = {
+    type: "admanager.googleapis.com/AdPartner"
+  }];
+}
+
+// Wrapper message for
+// [DeclarationTypeEnum][google.ads.admanager.v1.DeclarationTypeEnum].
+message DeclarationTypeEnum {
+  // The declaration about third party data usage on the associated entity.
+  enum DeclarationType {
+    // Default value. This value is unused.
+    DECLARATION_TYPE_UNSPECIFIED = 0;
+
+    // No ad technology providers to declare.
+    NONE = 1;
+
+    // There are are ad technology providers to declare on this entity.
+    DECLARED = 2;
+  }
+}

google/ads/admanager/v1/ad_partner_service.proto

@@ -0,0 +1,139 @@
+// Copyright 2023 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/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 = "AdPartnerServiceProto";
+option java_package = "com.google.ads.admanager.v1";
+option objc_class_prefix = "GAA";
+option php_namespace = "Google\\Ads\\AdManager\\V1";
+
+// Provides methods for handling AdPartner objects.
+service AdPartnerService {
+  option (google.api.default_host) = "admanager.googleapis.com";
+
+  // API to retrieve a AdPartner object.
+  rpc GetAdPartner(GetAdPartnerRequest) returns (AdPartner) {
+    option (google.api.http) = {
+      get: "/v1/{name=networks/*/adPartners/*}"
+    };
+    option (google.api.method_signature) = "name";
+  }
+
+  // API to retrieve a list of AdPartner objects.
+  rpc ListAdPartners(ListAdPartnersRequest) returns (ListAdPartnersResponse) {
+    option (google.api.http) = {
+      get: "/v1/{parent=networks/*}/adPartners"
+    };
+    option (google.api.method_signature) = "parent";
+  }
+}
+
+// The AdPartner resource.
+message AdPartner {
+  option (google.api.resource) = {
+    type: "admanager.googleapis.com/AdPartner"
+    pattern: "networks/{network_code}/adPartners/{ad_partner}"
+    plural: "adPartners"
+    singular: "adPartner"
+  };
+
+  // Identifier. The resource name of the AdPartner.
+  // Format: `networks/{network_code}/adPartners/{ad_partner_id}`
+  string name = 1 [(google.api.field_behavior) = IDENTIFIER];
+}
+
+// Request object for GetAdPartner method.
+message GetAdPartnerRequest {
+  // Required. The resource name of the AdPartner.
+  // Format: `networks/{network_code}/adPartners/{ad_partner_id}`
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "admanager.googleapis.com/AdPartner"
+    }
+  ];
+}
+
+// Request object for ListAdPartners method.
+message ListAdPartnersRequest {
+  // Required. The parent, which owns this collection of AdPartners.
+  // 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 AdPartners to return. The service may
+  // return fewer than this value. If unspecified, at most 50 AdPartners 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 `ListAdPartners` call.
+  // Provide this to retrieve the subsequent page.
+  //
+  // When paginating, all other parameters provided to `ListAdPartners` 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 ListAdPartnersRequest containing matching AdPartner
+// resources.
+message ListAdPartnersResponse {
+  // The AdPartner from the specified network.
+  repeated AdPartner ad_partners = 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 AdPartners.
+  // 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;
+}

google/ads/admanager/v1/ad_unit_enums.proto

@@ -0,0 +1,42 @@
+// Copyright 2023 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 = "AdUnitEnumsProto";
+option java_package = "com.google.ads.admanager.v1";
+option objc_class_prefix = "GAA";
+option php_namespace = "Google\\Ads\\AdManager\\V1";
+
+// Wrapper message for
+// [AppliedAdsenseEnabled][google.ads.admanager.v1.AppliedAdsenseEnabledEnum.AppliedAdsenseEnabled]
+message AppliedAdsenseEnabledEnum {
+  // Specifies if serving ads from the AdSense content network is enabled.
+  enum AppliedAdsenseEnabled {
+    // No adsense enabled setting applied directly; value will be inherited from
+    // parent or system default.
+    APPLIED_ADSENSE_ENABLED_UNSPECIFIED = 0;
+
+    // Serving ads from AdSense content network is enabled.
+    TRUE = 1;
+
+    // Serving ads from AdSense content network is disabled.
+    FALSE = 2;
+  }
+}