Reference documentation and code samples for the Google Ads Ad Manager V1 Client class FieldFilter.
A filter on a specific field.
Generated from protobuf message google.ads.admanager.v1.Report.Filter.FieldFilter
Namespace
Google \ Ads \ AdManager \ V1 \ Report \ FilterMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ field |
Google\Ads\AdManager\V1\Report\Field
Required. The field to filter on. |
↳ operation |
int
Required. The operation of this filter. |
↳ values |
array<Google\Ads\AdManager\V1\Report\Value>
Required. Values to filter to. |
↳ slice |
Google\Ads\AdManager\V1\Report\Slice
Optional. Use to filter on a specific slice of data. |
↳ time_period_index |
int
Optional. When using time period columns, use this to filter on a specific column. |
↳ metric_value_type |
int
Optional. Use to specify which metric value type to filter on. Defaults to PRIMARY. |
getField
Required. The field to filter on.
| Returns | |
|---|---|
| Type | Description |
Google\Ads\AdManager\V1\Report\Field|null |
|
hasField
clearField
setField
Required. The field to filter on.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Ads\AdManager\V1\Report\Field
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOperation
Required. The operation of this filter.
| Returns | |
|---|---|
| Type | Description |
int |
|
setOperation
Required. The operation of this filter.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getValues
Required. Values to filter to.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setValues
Required. Values to filter to.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Ads\AdManager\V1\Report\Value>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSlice
Optional. Use to filter on a specific slice of data.
| Returns | |
|---|---|
| Type | Description |
Google\Ads\AdManager\V1\Report\Slice|null |
|
hasSlice
clearSlice
setSlice
Optional. Use to filter on a specific slice of data.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Ads\AdManager\V1\Report\Slice
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTimePeriodIndex
Optional. When using time period columns, use this to filter on a specific column.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasTimePeriodIndex
clearTimePeriodIndex
setTimePeriodIndex
Optional. When using time period columns, use this to filter on a specific column.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMetricValueType
Optional. Use to specify which metric value type to filter on. Defaults to PRIMARY.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasMetricValueType
clearMetricValueType
setMetricValueType
Optional. Use to specify which metric value type to filter on. Defaults to PRIMARY.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|