google/ads/admanager/v1/company_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/applied_label.proto";
import "google/ads/admanager/v1/company_credit_status_enum.proto";
import "google/ads/admanager/v1/company_type_enum.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 = "CompanyServiceProto";
option java_package = "com.google.ads.admanager.v1";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\AdManager\\V1";

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

  // API to retrieve a `Company` object.
  rpc GetCompany(GetCompanyRequest) returns (Company) {
    option (google.api.http) = {
      get: "/v1/{name=networks/*/companies/*}"
    };
    option (google.api.method_signature) = "name";
  }

  // API to retrieve a list of `Company` objects.
  rpc ListCompanies(ListCompaniesRequest) returns (ListCompaniesResponse) {
    option (google.api.http) = {
      get: "/v1/{parent=networks/*}/companies"
    };
    option (google.api.method_signature) = "parent";
  }
}

// The `Company` resource.
message Company {
  option (google.api.resource) = {
    type: "admanager.googleapis.com/Company"
    pattern: "networks/{network_code}/companies/{company}"
    plural: "companies"
    singular: "company"
  };

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

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

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

  // Required. The type of the `Company`.
  CompanyTypeEnum.CompanyType type = 4 [(google.api.field_behavior) = REQUIRED];

  // Optional. The address for the `Company`.
  //
  // This value has a maximum length of 1024 characters.
  string address = 5 [(google.api.field_behavior) = OPTIONAL];

  // Optional. The email for the `Company`.
  //
  // This value has a maximum length of 128 characters.
  string email = 6 [(google.api.field_behavior) = OPTIONAL];

  // Optional. The fax number for the `Company`.
  //
  // This value has a maximum length of 63 characters.
  string fax = 7 [(google.api.field_behavior) = OPTIONAL];

  // Optional. The phone number for the `Company`.
  //
  // This value has a maximum length of 63 characters.
  string phone = 8 [(google.api.field_behavior) = OPTIONAL];

  // Optional. The external ID for the `Company`.
  //
  // This value has a maximum length of 255 characters.
  string external_id = 9 [(google.api.field_behavior) = OPTIONAL];

  // Optional. Comments about the `Company`.
  //
  // This value has a maximum length of 1024 characters.
  string comment = 10 [(google.api.field_behavior) = OPTIONAL];

  // Optional. The credit status of this company.
  //
  // This attribute defaults to `ACTIVE` if basic settings are enabled and
  // `ON_HOLD` if advance settings are enabled.
  CompanyCreditStatusEnum.CompanyCreditStatus credit_status = 11
      [(google.api.field_behavior) = OPTIONAL];

  // Optional. The labels that are directly applied to this company.
  repeated AppliedLabel applied_labels = 12
      [(google.api.field_behavior) = OPTIONAL];

  // Optional. The resource names of primary Contact of this company.
  // Format: "networks/{network_code}/contacts/{contact_id}"
  optional string primary_contact = 13 [
    (google.api.field_behavior) = OPTIONAL,
    (google.api.resource_reference) = {
      type: "admanager.googleapis.com/Contact"
    }
  ];

  // Optional. The resource names of Teams that are directly associated with
  // this company. Format: "networks/{network_code}/teams/{team_id}"
  repeated string applied_teams = 14 [
    (google.api.field_behavior) = OPTIONAL,
    (google.api.resource_reference) = { type: "admanager.googleapis.com/Team" }
  ];
}

// Request object for `GetCompany` method.
message GetCompanyRequest {
  // Required. The resource name of the Company.
  // Format: `networks/{network_code}/companies/{company_id}`
  string name = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "admanager.googleapis.com/Company"
    }
  ];
}

// Request object for `ListCompanies` method.
message ListCompaniesRequest {
  // Required. The parent, which owns this collection of Companies.
  // 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 `Companies` to return. The service may
  // return fewer than this value. If unspecified, at most 50 `Companies` 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 `ListCompanies` call.
  // Provide this to retrieve the subsequent page.
  //
  // When paginating, all other parameters provided to `ListCompanies` 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 `ListCompaniesRequest` containing matching `Company`
// resources.
message ListCompaniesResponse {
  // The `Company` from the specified network.
  repeated Company companies = 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 `Companies`.
  // 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;
}