Provides methods for creating, updating and retrieving DaiAuthenticationKey objects.
- Production WSDL
-
https://ads.google.com/apis/ads/publisher/v202208/DaiAuthenticationKeyService?wsdl
- Namespace
-
https://www.google.com/apis/ads/publisher/v202208
- Operations
- Errors
-
- ApiVersionError
- AuthenticationError
- CollectionSizeError
- CommonError
- DaiAuthenticationKeyActionError
- FeatureError
- InternalApiError
- NotNullError
- ParseError
- PermissionError
- PublisherQueryLanguageContextError
- PublisherQueryLanguageSyntaxError
- QuotaError
- RequiredCollectionError
- RequiredError
- ServerError
- StatementError
- StringFormatError
- StringLengthError
- UniqueError
createDaiAuthenticationKeys
Creates new DaiAuthenticationKey objects.
The following fields are required:
Parameters
Field | Type | Description |
---|---|---|
daiAuthenticationKeys
|
|
the DAI authentication keys to create |
Response
Field | Type | Description |
---|---|---|
rval
|
|
the created DAI authentication keys with their IDs filled in |
getDaiAuthenticationKeysByStatement
Gets a DaiAuthenticationKeyPage of DaiAuthenticationKey objects that satisfy the given Statement.query. The following fields are supported for filtering:
PQL Property | Object Property |
---|---|
id
|
DaiAuthenticationKey.id |
status
|
DaiAuthenticationKey.status |
name
|
DaiAuthenticationKey.name |
Parameters
Field | Type | Description |
---|---|---|
filterStatement
|
|
a Publisher Query Language statement to filter a list of DAI authentication keys |
Response
Field | Type | Description |
---|---|---|
rval
|
|
the DAI authentication keys that match the filter |
performDaiAuthenticationKeyAction
Performs actions on DaiAuthenticationKey objects that match the given Statement.query.
DAI authentication keys cannot be deactivated if there are active LiveStreamEvents or Content Sources that are using them.
Parameters
Field | Type | Description |
---|---|---|
daiAuthenticationKeyAction
|
|
the action to perform |
filterStatement
|
|
a Publisher Query Language statement used to filter a set of live stream events |
Response
Field | Type | Description |
---|---|---|
rval
|
|
the result of the action performed |
updateDaiAuthenticationKeys
Updates the specified DaiAuthenticationKey objects.
Parameters
Field | Type | Description |
---|---|---|
daiAuthenticationKeys
|
|
the video DAI authentication keys to update |
Response
Field | Type | Description |
---|---|---|
rval
|
|
the updated DAI authentication keys |
Errors
Error | Reasons |
---|---|
ApiVersionError
|
Errors related to the usage of API versions.
Enumerations
|
AuthenticationError
|
An error for an exception that occurred when authenticating.
Enumerations
|
CollectionSizeError
|
Error for the size of the collection being too large
Enumerations
|
CommonError
|
A place for common errors that can be used across services.
Enumerations
|
DaiAuthenticationKeyActionError
|
Lists all errors associated with DAI authentication key actions.
Enumerations
|
FeatureError
|
Errors related to feature management. If you attempt using a feature that is not available to
the current network you'll receive a FeatureError with the missing feature as the trigger.
Enumerations
|
InternalApiError
|
Indicates that a server-side error has occured. InternalApiError s
are generally not the result of an invalid request or message sent by the
client.
Enumerations
|
NotNullError
|
Caused by supplying a null value for an attribute that cannot be null.
Enumerations
|
ParseError
|
Lists errors related to parsing.
Enumerations
|
PermissionError
|
Errors related to incorrect permission.
Enumerations
|
PublisherQueryLanguageContextError
|
An error that occurs while executing a PQL query contained in
a Statement object.
Enumerations
|
PublisherQueryLanguageSyntaxError
|
An error that occurs while parsing a PQL query contained in a
Statement object.
Enumerations
|
QuotaError
|
Describes a client-side error on which a user is attempting
to perform an action to which they have no quota remaining.
Enumerations
|
RequiredCollectionError
|
A list of all errors to be used for validating sizes of collections.
Enumerations
|
RequiredError
|
Errors due to missing required field.
Enumerations
|
ServerError
|
Errors related to the server.
Enumerations
|
StatementError
|
An error that occurs while parsing Statement objects.
Enumerations
|
StringFormatError
|
A list of error code for reporting invalid content of input strings.
Enumerations
|
StringLengthError
|
Errors for Strings which do not meet given length constraints.
Enumerations
|
UniqueError
|
An error for a field which must satisfy a uniqueness constraint |