Google Ads Ad Manager V1 Client - Class RelativeDateRange (0.1.1)

Reference documentation and code samples for the Google Ads Ad Manager V1 Client class RelativeDateRange.

Options for relative date ranges.

Protobuf type google.ads.admanager.v1.Report.DateRange.RelativeDateRange

Namespace

Google \ Ads \ AdManager \ V1 \ Report \ DateRange

Methods

static::name

Parameter
Name Description
value mixed

static::value

Parameter
Name Description
name mixed

Constants

RELATIVE_DATE_RANGE_UNSPECIFIED

Value: 0

Default value. This value is unused.

Generated from protobuf enum RELATIVE_DATE_RANGE_UNSPECIFIED = 0;

TODAY

Value: 1

The date the report is run.

Generated from protobuf enum TODAY = 1;

YESTERDAY

Value: 2

The date a day before the date that the report is run.

Generated from protobuf enum YESTERDAY = 2;

THIS_WEEK

Value: 3

The full week in which this report is run. Could include dates in the future.

Generated from protobuf enum THIS_WEEK = 3;

THIS_WEEK_TO_DATE

Value: 29

From the beginning of the calendar week (Monday to Sunday) in which the up to and including the day the report is run.

Generated from protobuf enum THIS_WEEK_TO_DATE = 29;

THIS_MONTH

Value: 4

The full month in which this report is run. Could include dates in the future.

Generated from protobuf enum THIS_MONTH = 4;

THIS_MONTH_TO_DATE

Value: 26

From the beginning of the calendar month in which the report is run, to up to and including the day the report is run.

Generated from protobuf enum THIS_MONTH_TO_DATE = 26;

THIS_QUARTER

Value: 5

The full quarter in which this report is run. Could include dates in the future.

Generated from protobuf enum THIS_QUARTER = 5;

THIS_QUARTER_TO_DATE

Value: 27

From the beginning of the calendar quarter in which the report is run, up to and including the day the report is run.

Generated from protobuf enum THIS_QUARTER_TO_DATE = 27;

THIS_YEAR

Value: 6

The full year in which this report is run. Could include dates in the future.

Generated from protobuf enum THIS_YEAR = 6;

THIS_YEAR_TO_DATE

Value: 28

From the beginning of the calendar year in which the report is run, to up to and including the day the report is run.

Generated from protobuf enum THIS_YEAR_TO_DATE = 28;

LAST_WEEK

Value: 7

The entire previous calendar week, Monday to Sunday (inclusive), preceding the calendar week the report is run.

Generated from protobuf enum LAST_WEEK = 7;

LAST_MONTH

Value: 8

The entire previous calendar month preceding the calendar month the report is run.

Generated from protobuf enum LAST_MONTH = 8;

LAST_QUARTER

Value: 9

The entire previous calendar quarter preceding the calendar quarter the report is run.

Generated from protobuf enum LAST_QUARTER = 9;

LAST_YEAR

Value: 10

The entire previous calendar year preceding the calendar year the report is run.

Generated from protobuf enum LAST_YEAR = 10;

LAST_7_DAYS

Value: 11

The 7 days preceding the day the report is run.

Generated from protobuf enum LAST_7_DAYS = 11;

LAST_30_DAYS

Value: 12

The 30 days preceding the day the report is run.

Generated from protobuf enum LAST_30_DAYS = 12;

LAST_60_DAYS

Value: 13

The 60 days preceding the day the report is run.

Generated from protobuf enum LAST_60_DAYS = 13;

LAST_90_DAYS

Value: 14

The 90 days preceding the day the report is run.

Generated from protobuf enum LAST_90_DAYS = 14;

LAST_180_DAYS

Value: 15

The 180 days preceding the day the report is run.

Generated from protobuf enum LAST_180_DAYS = 15;

LAST_360_DAYS

Value: 16

The 360 days preceding the day the report is run.

Generated from protobuf enum LAST_360_DAYS = 16;

LAST_365_DAYS

Value: 17

The 365 days preceding the day the report is run.

Generated from protobuf enum LAST_365_DAYS = 17;

LAST_3_MONTHS

Value: 18

The entire previous 3 calendar months preceding the calendar month the report is run.

Generated from protobuf enum LAST_3_MONTHS = 18;

LAST_6_MONTHS

Value: 19

The entire previous 6 calendar months preceding the calendar month the report is run.

Generated from protobuf enum LAST_6_MONTHS = 19;

LAST_12_MONTHS

Value: 20

The entire previous 6 calendar months preceding the calendar month the report is run.

Generated from protobuf enum LAST_12_MONTHS = 20;

ALL_AVAILABLE

Value: 21

From 3 years before the report is run, to the day before the report is run, inclusive.

Generated from protobuf enum ALL_AVAILABLE = 21;

PREVIOUS_PERIOD

Value: 22

Only valid when used in the comparison_date_range field. The complete period preceding the date period provided in date_range.

In the case where date_range is a FixedDateRange of N days, this will be a period of N days where the end date is the date preceding the start date of the date_range. In the case where date_range is a RelativeDateRange, this will be a period of the same time frame preceding the date_range. In the case where the date_range does not capture the full period because a report is run in the middle of that period, this will still be the full preceding period. For example, if date_range is THIS_WEEK, but the report is run on a Wednesday, THIS_WEEK will be Monday - Wednesday, but PREVIOUS_PERIOD will be Monday - Sunday.

Generated from protobuf enum PREVIOUS_PERIOD = 22;

SAME_PERIOD_PREVIOUS_YEAR

Value: 24

Only valid when used in the comparison_date_range field. The period starting 1 year prior to the date period provided in date_range.

In the case where date_range is a FixedDateRange, this will be a date range starting 1 year prior to the date_range start date and ending 1 year prior to the date_range end date. In the case where date_range is a RelativeDateRange, this will be a period of the same time frame exactly 1 year prior to the date_range. In the case where the date_range does not capture the full period because a report is run in the middle of that period, this will still be the full period 1 year prior. For example, if date range is THIS_WEEK, but the report is run on a Wednesday, THIS_WEEK will be Monday - Wednesday, but SAME_PERIOD_PREVIOUS_YEAR will be Monday - Sunday.

Generated from protobuf enum SAME_PERIOD_PREVIOUS_YEAR = 24;