|
|
MasterAccountService
MasterAccountService provides operations for managing master accounts
(and for enrolling new customers with Yahoo! Search Marketing).
A master account is a collection of one or more accounts.
Operations
- getMasterAccount
- getMasterAccountsByCompanyID
- getMasterAccountStatus
- isMobileMasterAccount (added in Version 5.2.0)
- updateMasterAccount
getMasterAccount
Get information about the master account (specified by masterAccountID). You can get information about any master account to which you have access.
Capability required: MasterAccountRead
License command group: AccountManagement
Supported accounts: Web, Mobile
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| masterAccountID | string | The master account ID. |
Response
MasterAccount - The master account.
getMasterAccountsByCompanyID
Get all master accounts for a given company (specified by companyID)
Capability required: MasterAccountRead
License command group: AccountManagement
Supported accounts: Web, Mobile
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| companyID | long | The company ID. |
Response
MasterAccount[] - The list of master accounts belong to the company.
getMasterAccountStatus
Get the status of the master account (specified by masterAccountID). You can get information about any master account to which you have access.
Capability required: MasterAccountRead
License command group: AccountManagement
Supported accounts: Web, Mobile
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| masterAccountID | string | The master account ID. |
Response
MasterAccountStatus - The status of the master account.
isMobileMasterAccount
Returns whether a master account is a Mobile Sponsored Search master account
Added in: Version 5.2.0
Capability required: MasterAccountRead
License command group: AccountManagement
Supported accounts: Web, Mobile
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| masterAccountID | string | The master account ID. |
Response
boolean - true if the master account is a Mobile Sponsored Search master account, false if the master account is a web account.
updateMasterAccount
Update a master account. You can update any master account to which you have access.
Capability required: MasterAccountWrite
License command group: AccountManagement
Supported accounts: Web, Mobile
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| masterAccount | MasterAccount | The master account to be updated. |
Response
none