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 CohortsRangeOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.analytics.data.v1beta.CohortsRange) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Required. The granularity used to interpret the `startOffset` and 31 * `endOffset` for the extended reporting date range for a cohort report. 32 * </pre> 33 * 34 * <code>.google.analytics.data.v1beta.CohortsRange.Granularity granularity = 1;</code> 35 * 36 * @return The enum numeric value on the wire for granularity. 37 */ getGranularityValue()38 int getGranularityValue(); 39 /** 40 * 41 * 42 * <pre> 43 * Required. The granularity used to interpret the `startOffset` and 44 * `endOffset` for the extended reporting date range for a cohort report. 45 * </pre> 46 * 47 * <code>.google.analytics.data.v1beta.CohortsRange.Granularity granularity = 1;</code> 48 * 49 * @return The granularity. 50 */ getGranularity()51 com.google.analytics.data.v1beta.CohortsRange.Granularity getGranularity(); 52 53 /** 54 * 55 * 56 * <pre> 57 * `startOffset` specifies the start date of the extended reporting date range 58 * for a cohort report. `startOffset` is commonly set to 0 so that reports 59 * contain data from the acquisition of the cohort forward. 60 * If `granularity` is `DAILY`, the `startDate` of the extended reporting date 61 * range is `startDate` of the cohort plus `startOffset` days. 62 * If `granularity` is `WEEKLY`, the `startDate` of the extended reporting 63 * date range is `startDate` of the cohort plus `startOffset * 7` days. 64 * If `granularity` is `MONTHLY`, the `startDate` of the extended reporting 65 * date range is `startDate` of the cohort plus `startOffset * 30` days. 66 * </pre> 67 * 68 * <code>int32 start_offset = 2;</code> 69 * 70 * @return The startOffset. 71 */ getStartOffset()72 int getStartOffset(); 73 74 /** 75 * 76 * 77 * <pre> 78 * Required. `endOffset` specifies the end date of the extended reporting date 79 * range for a cohort report. `endOffset` can be any positive integer but is 80 * commonly set to 5 to 10 so that reports contain data on the cohort for the 81 * next several granularity time periods. 82 * If `granularity` is `DAILY`, the `endDate` of the extended reporting date 83 * range is `endDate` of the cohort plus `endOffset` days. 84 * If `granularity` is `WEEKLY`, the `endDate` of the extended reporting date 85 * range is `endDate` of the cohort plus `endOffset * 7` days. 86 * If `granularity` is `MONTHLY`, the `endDate` of the extended reporting date 87 * range is `endDate` of the cohort plus `endOffset * 30` days. 88 * </pre> 89 * 90 * <code>int32 end_offset = 3;</code> 91 * 92 * @return The endOffset. 93 */ getEndOffset()94 int getEndOffset(); 95 } 96