Reference documentation and code samples for the Google Ads Ad Manager V1 Client class AdManagerError.
/ AdManagerError contains all the information required for processing a / particular error thrown by the AdManager API.
/ / At least one AdManagerError should be included in all error messages sent to / the client.
Generated from protobuf message google.ads.admanager.v1.AdManagerError
Namespace
Google \ Ads \ AdManager \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ error_code |
string
The unique identifying string for this error. |
↳ message |
string
A publisher appropriate explanation of this error. |
↳ field_path |
string
The field path that triggered this error. |
↳ trigger |
string
The value that triggered this error. |
↳ stack_trace |
string
The stack trace that accompanies this error. |
↳ details |
array<Google\Protobuf\Any>
A list of messages that carry any additional error details. |
getErrorCode
The unique identifying string for this error.
| Returns | |
|---|---|
| Type | Description |
string |
|
setErrorCode
The unique identifying string for this error.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMessage
A publisher appropriate explanation of this error.
| Returns | |
|---|---|
| Type | Description |
string |
|
setMessage
A publisher appropriate explanation of this error.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFieldPath
The field path that triggered this error.
| Returns | |
|---|---|
| Type | Description |
string |
|
setFieldPath
The field path that triggered this error.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTrigger
The value that triggered this error.
| Returns | |
|---|---|
| Type | Description |
string |
|
setTrigger
The value that triggered this error.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStackTrace
The stack trace that accompanies this error.
| Returns | |
|---|---|
| Type | Description |
string |
|
setStackTrace
The stack trace that accompanies this error.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDetails
A list of messages that carry any additional error details.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setDetails
A list of messages that carry any additional error details.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Protobuf\Any>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|