admanager/v1/placement_service.proto

// 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/ads/admanager/v1/placement_enums.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/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 = "PlacementServiceProto";
option java_package = "com.google.ads.admanager.v1";
option objc_class_prefix = "GAA";
option php_namespace = "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";
  }
}

// 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];
}

// 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;
}