type DaiAuthenticationKey (v202505)

  • A DaiAuthenticationKey is used to authenticate stream requests to the IMA SDK API.

  • DaiAuthenticationKeys have unique read-only IDs, key values, creation dates/times, and statuses assigned by Google.

  • The status of a DaiAuthenticationKey can be Active or Inactive, and only Active keys are accepted by the IMA SDK API.

  • DaiAuthenticationKeys have a customizable name and a key type that determines how they are used for authentication (API or HMAC).
Service
DaiAuthenticationKeyService
Dependencies
DaiAuthenticationKeyPage createDaiAuthenticationKeys() updateDaiAuthenticationKeys()
▼
DaiAuthenticationKey

A DaiAuthenticationKey is used to authenticate stream requests to the IMA SDK API.

Namespace
https://www.google.com/apis/ads/publisher/v202505

Field

id

xsd:long

The unique ID of the DaiAuthenticationKey. This value is read-only and is assigned by Google.

key

xsd:string

The value of the secure key. This value is read-only and is assigned by Google.

creationDateTime

DateTime

The date and time this DaiAuthenticationKey was created. This value is read-only and is assigned by Google.

status

DaiAuthenticationKeyStatus

The status of this DaiAuthenticationKey. This value is read-only and is assigned by Google.

DAI authentication keys are created in the DaiAuthenticationKeyStatus.ACTIVE state. The status can only be modified through the DaiAuthenticationKeyService.performDaiAuthenticationKeyAction method.

Only active keys will be accepted by the IMA SDK API as valid.

Enumerations
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
ACTIVE
Indicates that the API key is actively in use and that the IMA SDK API should accept it as a valid key in requests.
INACTIVE
Indicates that the API key is no longer is use and that the IMA SDK API should not accept it as a valid key in requests.

name

xsd:string

The name for this DaiAuthenticationKey.

keyType

DaiAuthenticationKeyType

The type of this key, which determines how it should be used on stream create requests.

Enumerations
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
API
Indicates that the key is a standard API key and should be used with the api-key SDK parameter when authenticating stream create requests.
HMAC
Indicates that the key is an HMAC key and should be used to generate a signature for the stream create request with the auth-token SDK parameter.