|
| 1 | +/* |
| 2 | + * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except |
| 3 | + * in compliance with the License. You may obtain a copy of the License at |
| 4 | + * |
| 5 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 6 | + * |
| 7 | + * Unless required by applicable law or agreed to in writing, software distributed under the License |
| 8 | + * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express |
| 9 | + * or implied. See the License for the specific language governing permissions and limitations under |
| 10 | + * the License. |
| 11 | + */ |
| 12 | +/* |
| 13 | + * This code was generated by https://github.com/googleapis/google-api-java-client-services/ |
| 14 | + * Modify at your own risk. |
| 15 | + */ |
| 16 | + |
| 17 | +package com.google.api.services.displayvideo.v4.model; |
| 18 | + |
| 19 | +/** |
| 20 | + * Configuration for custom Active View video viewability metrics. |
| 21 | + * |
| 22 | + * <p> This is the Java data model class that specifies how to parse/serialize into the JSON that is |
| 23 | + * transmitted over HTTP when working with the Display & Video 360 API. For a detailed explanation |
| 24 | + * see: |
| 25 | + * <a href="https://developers.google.com/api-client-library/java/google-http-java-client/json">https://developers.google.com/api-client-library/java/google-http-java-client/json</a> |
| 26 | + * </p> |
| 27 | + * |
| 28 | + * @author Google, Inc. |
| 29 | + */ |
| 30 | +@SuppressWarnings("javadoc") |
| 31 | +public final class ActiveViewVideoViewabilityMetricConfig extends com.google.api.client.json.GenericJson { |
| 32 | + |
| 33 | + /** |
| 34 | + * Required. The display name of the custom metric. |
| 35 | + * The value may be {@code null}. |
| 36 | + */ |
| 37 | + @com.google.api.client.util.Key |
| 38 | + private java.lang.String displayName; |
| 39 | + |
| 40 | + /** |
| 41 | + * The minimum visible video duration required (in seconds) in order for an impression to be |
| 42 | + * recorded. You must specify minimum_duration, minimum_quartile or both. If both are specified, |
| 43 | + * an impression meets the metric criteria if either requirement is met (whichever happens first). |
| 44 | + * The value may be {@code null}. |
| 45 | + */ |
| 46 | + @com.google.api.client.util.Key |
| 47 | + private java.lang.String minimumDuration; |
| 48 | + |
| 49 | + /** |
| 50 | + * The minimum visible video duration required, based on the video quartiles, in order for an |
| 51 | + * impression to be recorded. You must specify minimum_duration, minimum_quartile or both. If both |
| 52 | + * are specified, an impression meets the metric criteria if either requirement is met (whichever |
| 53 | + * happens first). |
| 54 | + * The value may be {@code null}. |
| 55 | + */ |
| 56 | + @com.google.api.client.util.Key |
| 57 | + private java.lang.String minimumQuartile; |
| 58 | + |
| 59 | + /** |
| 60 | + * Required. The minimum percentage of the video ad's pixels visible on the screen in order for an |
| 61 | + * impression to be recorded. |
| 62 | + * The value may be {@code null}. |
| 63 | + */ |
| 64 | + @com.google.api.client.util.Key |
| 65 | + private java.lang.String minimumViewability; |
| 66 | + |
| 67 | + /** |
| 68 | + * Required. The minimum percentage of the video ad's volume required in order for an impression |
| 69 | + * to be recorded. |
| 70 | + * The value may be {@code null}. |
| 71 | + */ |
| 72 | + @com.google.api.client.util.Key |
| 73 | + private java.lang.String minimumVolume; |
| 74 | + |
| 75 | + /** |
| 76 | + * Required. The display name of the custom metric. |
| 77 | + * @return value or {@code null} for none |
| 78 | + */ |
| 79 | + public java.lang.String getDisplayName() { |
| 80 | + return displayName; |
| 81 | + } |
| 82 | + |
| 83 | + /** |
| 84 | + * Required. The display name of the custom metric. |
| 85 | + * @param displayName displayName or {@code null} for none |
| 86 | + */ |
| 87 | + public ActiveViewVideoViewabilityMetricConfig setDisplayName(java.lang.String displayName) { |
| 88 | + this.displayName = displayName; |
| 89 | + return this; |
| 90 | + } |
| 91 | + |
| 92 | + /** |
| 93 | + * The minimum visible video duration required (in seconds) in order for an impression to be |
| 94 | + * recorded. You must specify minimum_duration, minimum_quartile or both. If both are specified, |
| 95 | + * an impression meets the metric criteria if either requirement is met (whichever happens first). |
| 96 | + * @return value or {@code null} for none |
| 97 | + */ |
| 98 | + public java.lang.String getMinimumDuration() { |
| 99 | + return minimumDuration; |
| 100 | + } |
| 101 | + |
| 102 | + /** |
| 103 | + * The minimum visible video duration required (in seconds) in order for an impression to be |
| 104 | + * recorded. You must specify minimum_duration, minimum_quartile or both. If both are specified, |
| 105 | + * an impression meets the metric criteria if either requirement is met (whichever happens first). |
| 106 | + * @param minimumDuration minimumDuration or {@code null} for none |
| 107 | + */ |
| 108 | + public ActiveViewVideoViewabilityMetricConfig setMinimumDuration(java.lang.String minimumDuration) { |
| 109 | + this.minimumDuration = minimumDuration; |
| 110 | + return this; |
| 111 | + } |
| 112 | + |
| 113 | + /** |
| 114 | + * The minimum visible video duration required, based on the video quartiles, in order for an |
| 115 | + * impression to be recorded. You must specify minimum_duration, minimum_quartile or both. If both |
| 116 | + * are specified, an impression meets the metric criteria if either requirement is met (whichever |
| 117 | + * happens first). |
| 118 | + * @return value or {@code null} for none |
| 119 | + */ |
| 120 | + public java.lang.String getMinimumQuartile() { |
| 121 | + return minimumQuartile; |
| 122 | + } |
| 123 | + |
| 124 | + /** |
| 125 | + * The minimum visible video duration required, based on the video quartiles, in order for an |
| 126 | + * impression to be recorded. You must specify minimum_duration, minimum_quartile or both. If both |
| 127 | + * are specified, an impression meets the metric criteria if either requirement is met (whichever |
| 128 | + * happens first). |
| 129 | + * @param minimumQuartile minimumQuartile or {@code null} for none |
| 130 | + */ |
| 131 | + public ActiveViewVideoViewabilityMetricConfig setMinimumQuartile(java.lang.String minimumQuartile) { |
| 132 | + this.minimumQuartile = minimumQuartile; |
| 133 | + return this; |
| 134 | + } |
| 135 | + |
| 136 | + /** |
| 137 | + * Required. The minimum percentage of the video ad's pixels visible on the screen in order for an |
| 138 | + * impression to be recorded. |
| 139 | + * @return value or {@code null} for none |
| 140 | + */ |
| 141 | + public java.lang.String getMinimumViewability() { |
| 142 | + return minimumViewability; |
| 143 | + } |
| 144 | + |
| 145 | + /** |
| 146 | + * Required. The minimum percentage of the video ad's pixels visible on the screen in order for an |
| 147 | + * impression to be recorded. |
| 148 | + * @param minimumViewability minimumViewability or {@code null} for none |
| 149 | + */ |
| 150 | + public ActiveViewVideoViewabilityMetricConfig setMinimumViewability(java.lang.String minimumViewability) { |
| 151 | + this.minimumViewability = minimumViewability; |
| 152 | + return this; |
| 153 | + } |
| 154 | + |
| 155 | + /** |
| 156 | + * Required. The minimum percentage of the video ad's volume required in order for an impression |
| 157 | + * to be recorded. |
| 158 | + * @return value or {@code null} for none |
| 159 | + */ |
| 160 | + public java.lang.String getMinimumVolume() { |
| 161 | + return minimumVolume; |
| 162 | + } |
| 163 | + |
| 164 | + /** |
| 165 | + * Required. The minimum percentage of the video ad's volume required in order for an impression |
| 166 | + * to be recorded. |
| 167 | + * @param minimumVolume minimumVolume or {@code null} for none |
| 168 | + */ |
| 169 | + public ActiveViewVideoViewabilityMetricConfig setMinimumVolume(java.lang.String minimumVolume) { |
| 170 | + this.minimumVolume = minimumVolume; |
| 171 | + return this; |
| 172 | + } |
| 173 | + |
| 174 | + @Override |
| 175 | + public ActiveViewVideoViewabilityMetricConfig set(String fieldName, Object value) { |
| 176 | + return (ActiveViewVideoViewabilityMetricConfig) super.set(fieldName, value); |
| 177 | + } |
| 178 | + |
| 179 | + @Override |
| 180 | + public ActiveViewVideoViewabilityMetricConfig clone() { |
| 181 | + return (ActiveViewVideoViewabilityMetricConfig) super.clone(); |
| 182 | + } |
| 183 | + |
| 184 | +} |
0 commit comments