1 /* 2 * Copyright 2020 Google LLC 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * https://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 // Generated by the protocol buffer compiler. DO NOT EDIT! 17 // source: google/analytics/data/v1beta/data.proto 18 19 package com.google.analytics.data.v1beta; 20 21 public interface CohortOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.analytics.data.v1beta.Cohort) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Assigns a name to this cohort. The dimension `cohort` is valued to this 31 * name in a report response. If set, cannot begin with `cohort_` or 32 * `RESERVED_`. If not set, cohorts are named by their zero based index 33 * `cohort_0`, `cohort_1`, etc. 34 * </pre> 35 * 36 * <code>string name = 1;</code> 37 * 38 * @return The name. 39 */ getName()40 java.lang.String getName(); 41 /** 42 * 43 * 44 * <pre> 45 * Assigns a name to this cohort. The dimension `cohort` is valued to this 46 * name in a report response. If set, cannot begin with `cohort_` or 47 * `RESERVED_`. If not set, cohorts are named by their zero based index 48 * `cohort_0`, `cohort_1`, etc. 49 * </pre> 50 * 51 * <code>string name = 1;</code> 52 * 53 * @return The bytes for name. 54 */ getNameBytes()55 com.google.protobuf.ByteString getNameBytes(); 56 57 /** 58 * 59 * 60 * <pre> 61 * Dimension used by the cohort. Required and only supports 62 * `firstSessionDate`. 63 * </pre> 64 * 65 * <code>string dimension = 2;</code> 66 * 67 * @return The dimension. 68 */ getDimension()69 java.lang.String getDimension(); 70 /** 71 * 72 * 73 * <pre> 74 * Dimension used by the cohort. Required and only supports 75 * `firstSessionDate`. 76 * </pre> 77 * 78 * <code>string dimension = 2;</code> 79 * 80 * @return The bytes for dimension. 81 */ getDimensionBytes()82 com.google.protobuf.ByteString getDimensionBytes(); 83 84 /** 85 * 86 * 87 * <pre> 88 * The cohort selects users whose first touch date is between start date and 89 * end date defined in the `dateRange`. This `dateRange` does not specify the 90 * full date range of event data that is present in a cohort report. In a 91 * cohort report, this `dateRange` is extended by the granularity and offset 92 * present in the `cohortsRange`; event data for the extended reporting date 93 * range is present in a cohort report. 94 * In a cohort request, this `dateRange` is required and the `dateRanges` in 95 * the `RunReportRequest` or `RunPivotReportRequest` must be unspecified. 96 * This `dateRange` should generally be aligned with the cohort's granularity. 97 * If `CohortsRange` uses daily granularity, this `dateRange` can be a single 98 * day. If `CohortsRange` uses weekly granularity, this `dateRange` can be 99 * aligned to a week boundary, starting at Sunday and ending Saturday. If 100 * `CohortsRange` uses monthly granularity, this `dateRange` can be aligned to 101 * a month, starting at the first and ending on the last day of the month. 102 * </pre> 103 * 104 * <code>.google.analytics.data.v1beta.DateRange date_range = 3;</code> 105 * 106 * @return Whether the dateRange field is set. 107 */ hasDateRange()108 boolean hasDateRange(); 109 /** 110 * 111 * 112 * <pre> 113 * The cohort selects users whose first touch date is between start date and 114 * end date defined in the `dateRange`. This `dateRange` does not specify the 115 * full date range of event data that is present in a cohort report. In a 116 * cohort report, this `dateRange` is extended by the granularity and offset 117 * present in the `cohortsRange`; event data for the extended reporting date 118 * range is present in a cohort report. 119 * In a cohort request, this `dateRange` is required and the `dateRanges` in 120 * the `RunReportRequest` or `RunPivotReportRequest` must be unspecified. 121 * This `dateRange` should generally be aligned with the cohort's granularity. 122 * If `CohortsRange` uses daily granularity, this `dateRange` can be a single 123 * day. If `CohortsRange` uses weekly granularity, this `dateRange` can be 124 * aligned to a week boundary, starting at Sunday and ending Saturday. If 125 * `CohortsRange` uses monthly granularity, this `dateRange` can be aligned to 126 * a month, starting at the first and ending on the last day of the month. 127 * </pre> 128 * 129 * <code>.google.analytics.data.v1beta.DateRange date_range = 3;</code> 130 * 131 * @return The dateRange. 132 */ getDateRange()133 com.google.analytics.data.v1beta.DateRange getDateRange(); 134 /** 135 * 136 * 137 * <pre> 138 * The cohort selects users whose first touch date is between start date and 139 * end date defined in the `dateRange`. This `dateRange` does not specify the 140 * full date range of event data that is present in a cohort report. In a 141 * cohort report, this `dateRange` is extended by the granularity and offset 142 * present in the `cohortsRange`; event data for the extended reporting date 143 * range is present in a cohort report. 144 * In a cohort request, this `dateRange` is required and the `dateRanges` in 145 * the `RunReportRequest` or `RunPivotReportRequest` must be unspecified. 146 * This `dateRange` should generally be aligned with the cohort's granularity. 147 * If `CohortsRange` uses daily granularity, this `dateRange` can be a single 148 * day. If `CohortsRange` uses weekly granularity, this `dateRange` can be 149 * aligned to a week boundary, starting at Sunday and ending Saturday. If 150 * `CohortsRange` uses monthly granularity, this `dateRange` can be aligned to 151 * a month, starting at the first and ending on the last day of the month. 152 * </pre> 153 * 154 * <code>.google.analytics.data.v1beta.DateRange date_range = 3;</code> 155 */ getDateRangeOrBuilder()156 com.google.analytics.data.v1beta.DateRangeOrBuilder getDateRangeOrBuilder(); 157 } 158