google/ads/admanager/v1/custom_field_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/custom_field_enums.proto";
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 = "CustomFieldServiceProto";
option java_package = "com.google.ads.admanager.v1";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\AdManager\\V1";

// Provides methods for handling `CustomField` objects.
service CustomFieldService {
  option (google.api.default_host) = "admanager.googleapis.com";

  // API to retrieve a `CustomField` object.
  rpc GetCustomField(GetCustomFieldRequest) returns (CustomField) {
    option (google.api.http) = {
      get: "/v1/{name=networks/*/customFields/*}"
    };
    option (google.api.method_signature) = "name";
  }

  // API to retrieve a list of `CustomField` objects.
  rpc ListCustomFields(ListCustomFieldsRequest)
      returns (ListCustomFieldsResponse) {
    option (google.api.http) = {
      get: "/v1/{parent=networks/*}/customFields"
    };
    option (google.api.method_signature) = "parent";
  }
}

// The `CustomField` resource.
message CustomField {
  option (google.api.resource) = {
    type: "admanager.googleapis.com/CustomField"
    pattern: "networks/{network_code}/customFields/{custom_field}"
    plural: "customFields"
    singular: "customField"
  };

  // Identifier. The resource name of the `CustomField`.
  // Format: `networks/{network_code}/customFields/{custom_field_id}`
  string name = 1 [(google.api.field_behavior) = IDENTIFIER];

  // Output only. `CustomField` ID.
  int64 custom_field_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];

  // Required. The display name of the `CustomField`.
  //
  // This value has a maximum length of 127 characters.
  string display_name = 3 [(google.api.field_behavior) = REQUIRED];

  // Optional. The description of the `CustomField`.
  //
  // This value has a maximum length of 511 characters.
  string description = 4 [(google.api.field_behavior) = OPTIONAL];

  // Output only. The status of the `CustomField`.
  CustomFieldStatusEnum.CustomFieldStatus status = 5
      [(google.api.field_behavior) = OUTPUT_ONLY];

  // Required. The type of entity the `CustomField` can be applied to.
  CustomFieldEntityTypeEnum.CustomFieldEntityType entity_type = 7
      [(google.api.field_behavior) = REQUIRED];

  // Required. The data type of the `CustomField`.
  CustomFieldDataTypeEnum.CustomFieldDataType data_type = 8
      [(google.api.field_behavior) = REQUIRED];

  // Required. The visibility of the `CustomField`.
  CustomFieldVisibilityEnum.CustomFieldVisibility visibility = 9
      [(google.api.field_behavior) = REQUIRED];

  // Optional. The drop-down options for the `CustomField`.
  //
  // Only applicable for `CustomField` with the drop-down data type.
  repeated CustomFieldOption options = 10
      [(google.api.field_behavior) = OPTIONAL];
}

// An option for a drop-down `CustomField`.
message CustomFieldOption {
  // Output only. `CustomFieldOption` ID.
  int64 custom_field_option_id = 1 [(google.api.field_behavior) = OUTPUT_ONLY];

  // Required. The display name of the `CustomFieldOption`.
  //
  // This value has a maximum length of 127 characters.
  string display_name = 2 [(google.api.field_behavior) = REQUIRED];
}

// Request object for `GetCustomField` method.
message GetCustomFieldRequest {
  // Required. The resource name of the CustomField.
  // Format: `networks/{network_code}/customFields/{custom_field_id}`
  string name = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "admanager.googleapis.com/CustomField"
    }
  ];
}

// Request object for `ListCustomFields` method.
message ListCustomFieldsRequest {
  // Required. The parent, which owns this collection of CustomFields.
  // 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 `CustomFields` to return. The service may
  // return fewer than this value. If unspecified, at most 50 `CustomFields`
  // 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 `ListCustomFields` call.
  // Provide this to retrieve the subsequent page.
  //
  // When paginating, all other parameters provided to `ListCustomFields` 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://google.aip.dev/160
  string filter = 4 [(google.api.field_behavior) = OPTIONAL];

  // Optional. Expression to specify sorting order.
  // See syntax details at https://google.aip.dev/132#ordering
  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 `ListCustomFieldsRequest` containing matching
// `CustomField` objects.
message ListCustomFieldsResponse {
  // The `CustomField` objects from the specified network.
  repeated CustomField custom_fields = 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 `CustomField` 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
  // [System Parameters](https://cloud.google.com/apis/docs/system-parameters).
  int32 total_size = 3;
}