asset_set.proto 3.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879
  1. // Copyright 2022 Google LLC
  2. //
  3. // Licensed under the Apache License, Version 2.0 (the "License");
  4. // you may not use this file except in compliance with the License.
  5. // You may obtain a copy of the License at
  6. //
  7. // http://www.apache.org/licenses/LICENSE-2.0
  8. //
  9. // Unless required by applicable law or agreed to in writing, software
  10. // distributed under the License is distributed on an "AS IS" BASIS,
  11. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. // See the License for the specific language governing permissions and
  13. // limitations under the License.
  14. syntax = "proto3";
  15. package google.ads.googleads.v11.resources;
  16. import "google/ads/googleads/v11/enums/asset_set_status.proto";
  17. import "google/ads/googleads/v11/enums/asset_set_type.proto";
  18. import "google/api/field_behavior.proto";
  19. import "google/api/resource.proto";
  20. option csharp_namespace = "Google.Ads.GoogleAds.V11.Resources";
  21. option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v11/resources;resources";
  22. option java_multiple_files = true;
  23. option java_outer_classname = "AssetSetProto";
  24. option java_package = "com.google.ads.googleads.v11.resources";
  25. option objc_class_prefix = "GAA";
  26. option php_namespace = "Google\\Ads\\GoogleAds\\V11\\Resources";
  27. option ruby_package = "Google::Ads::GoogleAds::V11::Resources";
  28. // An asset set representing a collection of assets.
  29. // Use AssetSetAsset to link an asset to the asset set.
  30. message AssetSet {
  31. option (google.api.resource) = {
  32. type: "googleads.googleapis.com/AssetSet"
  33. pattern: "customers/{customer_id}/assetSets/{asset_set_id}"
  34. };
  35. // Merchant ID and Feed Label from Google Merchant Center.
  36. message MerchantCenterFeed {
  37. // Required. Merchant ID from Google Merchant Center
  38. int64 merchant_id = 1 [(google.api.field_behavior) = REQUIRED];
  39. // Optional. Feed Label from Google Merchant Center.
  40. optional string feed_label = 2 [(google.api.field_behavior) = OPTIONAL];
  41. }
  42. // Output only. The ID of the asset set.
  43. int64 id = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
  44. // Immutable. The resource name of the asset set.
  45. // Asset set resource names have the form:
  46. //
  47. // `customers/{customer_id}/assetSets/{asset_set_id}`
  48. string resource_name = 1 [
  49. (google.api.field_behavior) = IMMUTABLE,
  50. (google.api.resource_reference) = {
  51. type: "googleads.googleapis.com/AssetSet"
  52. }
  53. ];
  54. // Required. Name of the asset set. Required. It must have a minimum length of 1 and
  55. // maximum length of 128.
  56. string name = 2 [(google.api.field_behavior) = REQUIRED];
  57. // Required. Immutable. The type of the asset set. Required.
  58. google.ads.googleads.v11.enums.AssetSetTypeEnum.AssetSetType type = 3 [
  59. (google.api.field_behavior) = REQUIRED,
  60. (google.api.field_behavior) = IMMUTABLE
  61. ];
  62. // Output only. The status of the asset set. Read-only.
  63. google.ads.googleads.v11.enums.AssetSetStatusEnum.AssetSetStatus status = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
  64. // Merchant ID and Feed Label from Google Merchant Center.
  65. MerchantCenterFeed merchant_center_feed = 5;
  66. }