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

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

  // API to retrieve a Creative object.
  rpc GetCreative(GetCreativeRequest) returns (Creative) {
    option (google.api.http) = {
      get: "/v1/{name=networks/*/creatives/*}"
    };
    option (google.api.method_signature) = "name";
  }

  // API to retrieve a list of Creative objects.
  rpc ListCreatives(ListCreativesRequest) returns (ListCreativesResponse) {
    option (google.api.http) = {
      get: "/v1/{parent=networks/*}/creatives"
    };
    option (google.api.method_signature) = "parent";
  }
}

// The Creative resource.
message Creative {
  option (google.api.resource) = {
    type: "admanager.googleapis.com/Creative"
    pattern: "networks/{network_code}/creatives/{creative}"
    plural: "creatives"
    singular: "creative"
  };

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

  // Output only. `Creative` ID.
  int64 creative_id = 7 [(google.api.field_behavior) = OUTPUT_ONLY];

  // Optional. Display name of the `Creative`. This attribute has a maximum
  // length of 255 characters.
  string display_name = 8 [(google.api.field_behavior) = OPTIONAL];

  // Required. The resource name of the Company, which is of type
  // Company.Type.ADVERTISER, to which this Creative belongs. Format:
  // "networks/{network_code}/companies/{company_id}"
  string advertiser = 2 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "admanager.googleapis.com/Company"
    }
  ];

  // Output only. The instant this Creative was last modified.
  google.protobuf.Timestamp update_time = 3
      [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The URL of the creative for previewing the media.
  string preview_url = 4 [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. String representations of creative size.
  // This field is temporarily available and will be deprecated when
  // `Creative.size` becomes available.
  string size_label = 9 [(google.api.field_behavior) = OUTPUT_ONLY];

  // Optional. The Ad Partners associated with this creative.
  // This is distinct from any associated companies that Google may detect
  // programmatically.
  AdPartnerDeclaration ad_partner_declaration = 6
      [(google.api.field_behavior) = OPTIONAL];
}

// Request object for GetCreative method.
message GetCreativeRequest {
  // Required. The resource name of the Creative.
  // Format: `networks/{network_code}/creatives/{creative_id}`
  string name = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "admanager.googleapis.com/Creative"
    }
  ];
}

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