com.google.api.ads.admanager.axis.v202008

Interface DaiAuthenticationKeyServiceInterface

All Superinterfaces:

Remote

All Known Implementing Classes:

DaiAuthenticationKeyServiceSoapBindingStub

public interface DaiAuthenticationKeyServiceInterface
extends Remote

Method Summary

Modifier and Type	Method and Description
DaiAuthenticationKey[]	createDaiAuthenticationKeys(DaiAuthenticationKey[] daiAuthenticationKeys) Creates new DaiAuthenticationKey objects.
DaiAuthenticationKeyPage	getDaiAuthenticationKeysByStatement(Statement filterStatement) Gets a DaiAuthenticationKeyPage of DaiAuthenticationKey objects that satisfy the given Statement.query.
UpdateResult	performDaiAuthenticationKeyAction(DaiAuthenticationKeyAction daiAuthenticationKeyAction, Statement filterStatement) Performs actions on DaiAuthenticationKey objects that match the given Statement.query.
DaiAuthenticationKey[]	updateDaiAuthenticationKeys(DaiAuthenticationKey[] daiAuthenticationKeys) Updates the specified DaiAuthenticationKey objects.

Method Detail

createDaiAuthenticationKeys

DaiAuthenticationKey[] createDaiAuthenticationKeys(DaiAuthenticationKey[] daiAuthenticationKeys)
                                            throws RemoteException,
                                                   ApiException

Creates new DaiAuthenticationKey objects.

The following fields are required:

• DaiAuthenticationKey.name

Parameters:

daiAuthenticationKeys - the DAI authentication keys to create

Returns:

the created DAI authentication keys with their IDs filled in

Throws:

RemoteException

ApiException

getDaiAuthenticationKeysByStatement

DaiAuthenticationKeyPage getDaiAuthenticationKeysByStatement(Statement filterStatement)
                                                      throws RemoteException,
                                                             ApiException

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:

filterStatement - a Publisher Query Language statement to filter a list of DAI authentication keys

Returns:

the DAI authentication keys that match the filter

Throws:

RemoteException

ApiException

performDaiAuthenticationKeyAction

UpdateResult performDaiAuthenticationKeyAction(DaiAuthenticationKeyAction daiAuthenticationKeyAction,
                                               Statement filterStatement)
                                        throws RemoteException,
                                               ApiException

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:

daiAuthenticationKeyAction - the action to perform

filterStatement - a Publisher Query Language statement used to filter a set of live stream events

Returns:

the result of the action performed

Throws:

RemoteException

ApiException

updateDaiAuthenticationKeys

DaiAuthenticationKey[] updateDaiAuthenticationKeys(DaiAuthenticationKey[] daiAuthenticationKeys)
                                            throws RemoteException,
                                                   ApiException

Updates the specified DaiAuthenticationKey objects.

Parameters:

daiAuthenticationKeys - the video DAI authentication keys to update

Returns:

the updated DAI authentication keys

Throws:

ApiException - if there is an error updating the DAI authentication keys

RemoteException