customer_asset.proto 2.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
  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.v10.resources;
  16. import "google/ads/googleads/v10/enums/asset_field_type.proto";
  17. import "google/ads/googleads/v10/enums/asset_link_status.proto";
  18. import "google/api/field_behavior.proto";
  19. import "google/api/resource.proto";
  20. option csharp_namespace = "Google.Ads.GoogleAds.V10.Resources";
  21. option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/resources;resources";
  22. option java_multiple_files = true;
  23. option java_outer_classname = "CustomerAssetProto";
  24. option java_package = "com.google.ads.googleads.v10.resources";
  25. option objc_class_prefix = "GAA";
  26. option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Resources";
  27. option ruby_package = "Google::Ads::GoogleAds::V10::Resources";
  28. // Proto file describing the CustomerAsset resource.
  29. // A link between a customer and an asset.
  30. message CustomerAsset {
  31. option (google.api.resource) = {
  32. type: "googleads.googleapis.com/CustomerAsset"
  33. pattern: "customers/{customer_id}/customerAssets/{asset_id}~{field_type}"
  34. };
  35. // Immutable. The resource name of the customer asset.
  36. // CustomerAsset resource names have the form:
  37. //
  38. // `customers/{customer_id}/customerAssets/{asset_id}~{field_type}`
  39. string resource_name = 1 [
  40. (google.api.field_behavior) = IMMUTABLE,
  41. (google.api.resource_reference) = {
  42. type: "googleads.googleapis.com/CustomerAsset"
  43. }
  44. ];
  45. // Required. Immutable. The asset which is linked to the customer.
  46. string asset = 2 [
  47. (google.api.field_behavior) = REQUIRED,
  48. (google.api.field_behavior) = IMMUTABLE,
  49. (google.api.resource_reference) = {
  50. type: "googleads.googleapis.com/Asset"
  51. }
  52. ];
  53. // Required. Immutable. Role that the asset takes for the customer link.
  54. google.ads.googleads.v10.enums.AssetFieldTypeEnum.AssetFieldType field_type = 3 [
  55. (google.api.field_behavior) = REQUIRED,
  56. (google.api.field_behavior) = IMMUTABLE
  57. ];
  58. // Status of the customer asset.
  59. google.ads.googleads.v10.enums.AssetLinkStatusEnum.AssetLinkStatus status = 4;
  60. }