Google Ads Ad Manager V1 Client - Class Report (0.1.2)

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

The Report resource.

Generated from protobuf message google.ads.admanager.v1.Report

Namespace

Google \ Ads \ AdManager \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Identifier. The resource name of the report. Report resource name have the form: networks/{network_code}/reports/{report_id}

↳ report_id int|string

Output only. Report ID.

↳ visibility int

Optional. The visibility of a report.

↳ report_definition ReportDefinition

Required. The report definition of the report.

↳ display_name string

Optional. Display name for the report.

↳ update_time Google\Protobuf\Timestamp

Output only. The instant this report was last modified.

↳ create_time Google\Protobuf\Timestamp

Output only. The instant this report was created.

↳ locale string

Output only. The locale of this report. Locale is set from the user's locale at the time of the request. Locale can not be modified.

↳ schedule_options ScheduleOptions

Optional. The schedule options of this report.

getName

Identifier. The resource name of the report.

Report resource name have the form: networks/{network_code}/reports/{report_id}

Returns
Type Description
string

setName

Identifier. The resource name of the report.

Report resource name have the form: networks/{network_code}/reports/{report_id}

Parameter
Name Description
var string
Returns
Type Description
$this

getReportId

Output only. Report ID.

Returns
Type Description
int|string

setReportId

Output only. Report ID.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getVisibility

Optional. The visibility of a report.

Returns
Type Description
int

setVisibility

Optional. The visibility of a report.

Parameter
Name Description
var int
Returns
Type Description
$this

getReportDefinition

Required. The report definition of the report.

Returns
Type Description
ReportDefinition|null

hasReportDefinition

clearReportDefinition

setReportDefinition

Required. The report definition of the report.

Parameter
Name Description
var ReportDefinition
Returns
Type Description
$this

getDisplayName

Optional. Display name for the report.

Returns
Type Description
string

setDisplayName

Optional. Display name for the report.

Parameter
Name Description
var string
Returns
Type Description
$this

getUpdateTime

Output only. The instant this report was last modified.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The instant this report was last modified.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getCreateTime

Output only. The instant this report was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The instant this report was created.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getLocale

Output only. The locale of this report. Locale is set from the user's locale at the time of the request. Locale can not be modified.

Returns
Type Description
string

setLocale

Output only. The locale of this report. Locale is set from the user's locale at the time of the request. Locale can not be modified.

Parameter
Name Description
var string
Returns
Type Description
$this

getScheduleOptions

Optional. The schedule options of this report.

Returns
Type Description
ScheduleOptions|null

hasScheduleOptions

clearScheduleOptions

setScheduleOptions

Optional. The schedule options of this report.

Parameter
Name Description
var ScheduleOptions
Returns
Type Description
$this