Reference documentation and code samples for the Google Ads Ad Manager V1 Client class DaiAuthenticationKey.
A DaiAuthenticationKey is used to authenticate stream requests to the IMA SDK API.
Generated from protobuf message google.ads.admanager.v1.DaiAuthenticationKey
Namespace
Google \ Ads \ AdManager \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. The resource name of the |
↳ status |
int
Output only. The status of this DaiAuthenticationKey. DAI authentication keys are created in the |
↳ display_name |
string
Required. The name for this DaiAuthenticationKey. |
↳ key_type |
int
Optional. The type of this key, which determines how it should be used on stream create requests. |
getName
Identifier. The resource name of the DaiAuthenticationKey.
Format:
networks/{network_code}/daiAuthenticationKeys/{dai_authentication_key}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. The resource name of the DaiAuthenticationKey.
Format:
networks/{network_code}/daiAuthenticationKeys/{dai_authentication_key}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStatus
Output only. The status of this DaiAuthenticationKey.
DAI authentication keys are created in the
ACTIVE
state.
Only active keys will be accepted by the IMA SDK API as valid.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasStatus
clearStatus
setStatus
Output only. The status of this DaiAuthenticationKey.
DAI authentication keys are created in the
ACTIVE
state.
Only active keys will be accepted by the IMA SDK API as valid.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
Required. The name for this DaiAuthenticationKey.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasDisplayName
clearDisplayName
setDisplayName
Required. The name for this DaiAuthenticationKey.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getKeyType
Optional. The type of this key, which determines how it should be used on stream create requests.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasKeyType
clearKeyType
setKeyType
Optional. The type of this key, which determines how it should be used on stream create requests.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|