1// Copyright 2023 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 15syntax = "proto3"; 16 17package google.ads.googleads.v15.resources; 18 19import "google/ads/googleads/v15/common/asset_policy.proto"; 20import "google/ads/googleads/v15/enums/asset_field_type.proto"; 21import "google/ads/googleads/v15/enums/asset_link_primary_status.proto"; 22import "google/ads/googleads/v15/enums/asset_link_primary_status_reason.proto"; 23import "google/ads/googleads/v15/enums/asset_link_status.proto"; 24import "google/ads/googleads/v15/enums/asset_source.proto"; 25import "google/api/field_behavior.proto"; 26import "google/api/resource.proto"; 27 28option csharp_namespace = "Google.Ads.GoogleAds.V15.Resources"; 29option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v15/resources;resources"; 30option java_multiple_files = true; 31option java_outer_classname = "AdGroupAssetProto"; 32option java_package = "com.google.ads.googleads.v15.resources"; 33option objc_class_prefix = "GAA"; 34option php_namespace = "Google\\Ads\\GoogleAds\\V15\\Resources"; 35option ruby_package = "Google::Ads::GoogleAds::V15::Resources"; 36 37// Proto file describing the AdGroupAsset resource. 38 39// A link between an ad group and an asset. 40message AdGroupAsset { 41 option (google.api.resource) = { 42 type: "googleads.googleapis.com/AdGroupAsset" 43 pattern: "customers/{customer_id}/adGroupAssets/{ad_group_id}~{asset_id}~{field_type}" 44 }; 45 46 // Immutable. The resource name of the ad group asset. 47 // AdGroupAsset resource names have the form: 48 // 49 // `customers/{customer_id}/adGroupAssets/{ad_group_id}~{asset_id}~{field_type}` 50 string resource_name = 1 [ 51 (google.api.field_behavior) = IMMUTABLE, 52 (google.api.resource_reference) = { 53 type: "googleads.googleapis.com/AdGroupAsset" 54 } 55 ]; 56 57 // Required. Immutable. The ad group to which the asset is linked. 58 string ad_group = 2 [ 59 (google.api.field_behavior) = REQUIRED, 60 (google.api.field_behavior) = IMMUTABLE, 61 (google.api.resource_reference) = { 62 type: "googleads.googleapis.com/AdGroup" 63 } 64 ]; 65 66 // Required. Immutable. The asset which is linked to the ad group. 67 string asset = 3 [ 68 (google.api.field_behavior) = REQUIRED, 69 (google.api.field_behavior) = IMMUTABLE, 70 (google.api.resource_reference) = { type: "googleads.googleapis.com/Asset" } 71 ]; 72 73 // Required. Immutable. Role that the asset takes under the linked ad group. 74 google.ads.googleads.v15.enums.AssetFieldTypeEnum.AssetFieldType field_type = 75 4 [ 76 (google.api.field_behavior) = REQUIRED, 77 (google.api.field_behavior) = IMMUTABLE 78 ]; 79 80 // Output only. Source of the adgroup asset link. 81 google.ads.googleads.v15.enums.AssetSourceEnum.AssetSource source = 6 82 [(google.api.field_behavior) = OUTPUT_ONLY]; 83 84 // Status of the ad group asset. 85 google.ads.googleads.v15.enums.AssetLinkStatusEnum.AssetLinkStatus status = 5; 86 87 // Output only. Provides the PrimaryStatus of this asset link. 88 // Primary status is meant essentially to differentiate between the plain 89 // "status" field, which has advertiser set values of enabled, paused, or 90 // removed. The primary status takes into account other signals (for assets 91 // its mainly policy and quality approvals) to come up with a more 92 // comprehensive status to indicate its serving state. 93 google.ads.googleads.v15.enums.AssetLinkPrimaryStatusEnum 94 .AssetLinkPrimaryStatus primary_status = 7 95 [(google.api.field_behavior) = OUTPUT_ONLY]; 96 97 // Output only. Provides the details of the primary status and its associated 98 // reasons. 99 repeated google.ads.googleads.v15.common.AssetLinkPrimaryStatusDetails 100 primary_status_details = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; 101 102 // Output only. Provides a list of reasons for why an asset is not serving or 103 // not serving at full capacity. 104 repeated google.ads.googleads.v15.enums.AssetLinkPrimaryStatusReasonEnum 105 .AssetLinkPrimaryStatusReason primary_status_reasons = 9 106 [(google.api.field_behavior) = OUTPUT_ONLY]; 107} 108