LINE Messaging API SDK for PHP

ManageAudienceApi

ManageAudienceApi Class Doc Comment

Tags
category

Class

author

OpenAPI Generator team

link
https://openapi-generator.tech

Table of Contents

contentTypes  = ['addAudienceToAudienceGroup' => ['application/json'], 'createAudienceGroup' => ['application/json'], 'createClickBasedAudienceGroup' => ['application/json'], 'createImpBasedAudienceGroup' => ['application/json'], 'deleteAudienceGroup' => ['application/json'], 'getAudienceData' => ['application/json'], 'getAudienceGroups' => ['application/json'], 'getSharedAudienceData' => ['application/json'], 'getSharedAudienceGroups' => ['application/json'], 'updateAudienceGroupDescription' => ['application/json']]
$client  : ClientInterface
$config  : Configuration
$headerSelector  : HeaderSelector
$hostIndex  : int
__construct()  : mixed
addAudienceToAudienceGroup()  : void
Operation addAudienceToAudienceGroup
addAudienceToAudienceGroupAsync()  : PromiseInterface
Operation addAudienceToAudienceGroupAsync
addAudienceToAudienceGroupAsyncWithHttpInfo()  : PromiseInterface
Operation addAudienceToAudienceGroupAsyncWithHttpInfo
addAudienceToAudienceGroupRequest()  : Request
Create request for operation 'addAudienceToAudienceGroup'
addAudienceToAudienceGroupWithHttpInfo()  : array<string|int, mixed>
Operation addAudienceToAudienceGroupWithHttpInfo
createAudienceGroup()  : CreateAudienceGroupResponse
Operation createAudienceGroup
createAudienceGroupAsync()  : PromiseInterface
Operation createAudienceGroupAsync
createAudienceGroupAsyncWithHttpInfo()  : PromiseInterface
Operation createAudienceGroupAsyncWithHttpInfo
createAudienceGroupRequest()  : Request
Create request for operation 'createAudienceGroup'
createAudienceGroupWithHttpInfo()  : array<string|int, mixed>
Operation createAudienceGroupWithHttpInfo
createClickBasedAudienceGroup()  : CreateClickBasedAudienceGroupResponse
Operation createClickBasedAudienceGroup
createClickBasedAudienceGroupAsync()  : PromiseInterface
Operation createClickBasedAudienceGroupAsync
createClickBasedAudienceGroupAsyncWithHttpInfo()  : PromiseInterface
Operation createClickBasedAudienceGroupAsyncWithHttpInfo
createClickBasedAudienceGroupRequest()  : Request
Create request for operation 'createClickBasedAudienceGroup'
createClickBasedAudienceGroupWithHttpInfo()  : array<string|int, mixed>
Operation createClickBasedAudienceGroupWithHttpInfo
createImpBasedAudienceGroup()  : CreateImpBasedAudienceGroupResponse
Operation createImpBasedAudienceGroup
createImpBasedAudienceGroupAsync()  : PromiseInterface
Operation createImpBasedAudienceGroupAsync
createImpBasedAudienceGroupAsyncWithHttpInfo()  : PromiseInterface
Operation createImpBasedAudienceGroupAsyncWithHttpInfo
createImpBasedAudienceGroupRequest()  : Request
Create request for operation 'createImpBasedAudienceGroup'
createImpBasedAudienceGroupWithHttpInfo()  : array<string|int, mixed>
Operation createImpBasedAudienceGroupWithHttpInfo
deleteAudienceGroup()  : void
Operation deleteAudienceGroup
deleteAudienceGroupAsync()  : PromiseInterface
Operation deleteAudienceGroupAsync
deleteAudienceGroupAsyncWithHttpInfo()  : PromiseInterface
Operation deleteAudienceGroupAsyncWithHttpInfo
deleteAudienceGroupRequest()  : Request
Create request for operation 'deleteAudienceGroup'
deleteAudienceGroupWithHttpInfo()  : array<string|int, mixed>
Operation deleteAudienceGroupWithHttpInfo
getAudienceData()  : GetAudienceDataResponse|ErrorResponse
Operation getAudienceData
getAudienceDataAsync()  : PromiseInterface
Operation getAudienceDataAsync
getAudienceDataAsyncWithHttpInfo()  : PromiseInterface
Operation getAudienceDataAsyncWithHttpInfo
getAudienceDataRequest()  : Request
Create request for operation 'getAudienceData'
getAudienceDataWithHttpInfo()  : array<string|int, mixed>
Operation getAudienceDataWithHttpInfo
getAudienceGroups()  : GetAudienceGroupsResponse
Operation getAudienceGroups
getAudienceGroupsAsync()  : PromiseInterface
Operation getAudienceGroupsAsync
getAudienceGroupsAsyncWithHttpInfo()  : PromiseInterface
Operation getAudienceGroupsAsyncWithHttpInfo
getAudienceGroupsRequest()  : Request
Create request for operation 'getAudienceGroups'
getAudienceGroupsWithHttpInfo()  : array<string|int, mixed>
Operation getAudienceGroupsWithHttpInfo
getConfig()  : Configuration
getHostIndex()  : int
Get the host index
getSharedAudienceData()  : GetSharedAudienceDataResponse|ErrorResponse
Operation getSharedAudienceData
getSharedAudienceDataAsync()  : PromiseInterface
Operation getSharedAudienceDataAsync
getSharedAudienceDataAsyncWithHttpInfo()  : PromiseInterface
Operation getSharedAudienceDataAsyncWithHttpInfo
getSharedAudienceDataRequest()  : Request
Create request for operation 'getSharedAudienceData'
getSharedAudienceDataWithHttpInfo()  : array<string|int, mixed>
Operation getSharedAudienceDataWithHttpInfo
getSharedAudienceGroups()  : GetSharedAudienceGroupsResponse
Operation getSharedAudienceGroups
getSharedAudienceGroupsAsync()  : PromiseInterface
Operation getSharedAudienceGroupsAsync
getSharedAudienceGroupsAsyncWithHttpInfo()  : PromiseInterface
Operation getSharedAudienceGroupsAsyncWithHttpInfo
getSharedAudienceGroupsRequest()  : Request
Create request for operation 'getSharedAudienceGroups'
getSharedAudienceGroupsWithHttpInfo()  : array<string|int, mixed>
Operation getSharedAudienceGroupsWithHttpInfo
setHostIndex()  : void
Set the host index
updateAudienceGroupDescription()  : void
Operation updateAudienceGroupDescription
updateAudienceGroupDescriptionAsync()  : PromiseInterface
Operation updateAudienceGroupDescriptionAsync
updateAudienceGroupDescriptionAsyncWithHttpInfo()  : PromiseInterface
Operation updateAudienceGroupDescriptionAsyncWithHttpInfo
updateAudienceGroupDescriptionRequest()  : Request
Create request for operation 'updateAudienceGroupDescription'
updateAudienceGroupDescriptionWithHttpInfo()  : array<string|int, mixed>
Operation updateAudienceGroupDescriptionWithHttpInfo
createHttpClientOption()  : array<string|int, mixed>
Create http client option

Constants

contentTypes

public array<string|int, string> contentTypes = ['addAudienceToAudienceGroup' => ['application/json'], 'createAudienceGroup' => ['application/json'], 'createClickBasedAudienceGroup' => ['application/json'], 'createImpBasedAudienceGroup' => ['application/json'], 'deleteAudienceGroup' => ['application/json'], 'getAudienceData' => ['application/json'], 'getAudienceGroups' => ['application/json'], 'getSharedAudienceData' => ['application/json'], 'getSharedAudienceGroups' => ['application/json'], 'updateAudienceGroupDescription' => ['application/json']]

Properties

Methods

__construct()

public __construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ], int $hostIndex) : mixed
Parameters
$client : ClientInterface = null
$config : Configuration = null
$selector : HeaderSelector = null
$hostIndex : int

(Optional) host index to select the list of hosts if defined in the OpenAPI spec

Return values
mixed

addAudienceToAudienceGroup()

Operation addAudienceToAudienceGroup

public addAudienceToAudienceGroup(AddAudienceToAudienceGroupRequest $addAudienceToAudienceGroupRequest[, string $contentType = self::contentTypes['addAudienceToAudienceGroup'][0] ]) : void
Parameters
$addAudienceToAudienceGroupRequest : AddAudienceToAudienceGroupRequest

addAudienceToAudienceGroupRequest (required)

$contentType : string = self::contentTypes['addAudienceToAudienceGroup'][0]

The value for the Content-Type header. Check self::contentTypes['addAudienceToAudienceGroup'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

throws
InvalidArgumentException
Return values
void

addAudienceToAudienceGroupAsync()

Operation addAudienceToAudienceGroupAsync

public addAudienceToAudienceGroupAsync(AddAudienceToAudienceGroupRequest $addAudienceToAudienceGroupRequest[, string $contentType = self::contentTypes['addAudienceToAudienceGroup'][0] ]) : PromiseInterface
Parameters
$addAudienceToAudienceGroupRequest : AddAudienceToAudienceGroupRequest

(required)

$contentType : string = self::contentTypes['addAudienceToAudienceGroup'][0]

The value for the Content-Type header. Check self::contentTypes['addAudienceToAudienceGroup'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

addAudienceToAudienceGroupAsyncWithHttpInfo()

Operation addAudienceToAudienceGroupAsyncWithHttpInfo

public addAudienceToAudienceGroupAsyncWithHttpInfo(AddAudienceToAudienceGroupRequest $addAudienceToAudienceGroupRequest[, string $contentType = self::contentTypes['addAudienceToAudienceGroup'][0] ]) : PromiseInterface
Parameters
$addAudienceToAudienceGroupRequest : AddAudienceToAudienceGroupRequest

(required)

$contentType : string = self::contentTypes['addAudienceToAudienceGroup'][0]

The value for the Content-Type header. Check self::contentTypes['addAudienceToAudienceGroup'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

addAudienceToAudienceGroupRequest()

Create request for operation 'addAudienceToAudienceGroup'

public addAudienceToAudienceGroupRequest(AddAudienceToAudienceGroupRequest $addAudienceToAudienceGroupRequest[, string $contentType = self::contentTypes['addAudienceToAudienceGroup'][0] ]) : Request
Parameters
$addAudienceToAudienceGroupRequest : AddAudienceToAudienceGroupRequest

(required)

$contentType : string = self::contentTypes['addAudienceToAudienceGroup'][0]

The value for the Content-Type header. Check self::contentTypes['addAudienceToAudienceGroup'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

addAudienceToAudienceGroupWithHttpInfo()

Operation addAudienceToAudienceGroupWithHttpInfo

public addAudienceToAudienceGroupWithHttpInfo(AddAudienceToAudienceGroupRequest $addAudienceToAudienceGroupRequest[, string $contentType = self::contentTypes['addAudienceToAudienceGroup'][0] ]) : array<string|int, mixed>
Parameters
$addAudienceToAudienceGroupRequest : AddAudienceToAudienceGroupRequest

(required)

$contentType : string = self::contentTypes['addAudienceToAudienceGroup'][0]

The value for the Content-Type header. Check self::contentTypes['addAudienceToAudienceGroup'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of null, HTTP status code, HTTP response headers (array of strings)

createAudienceGroup()

Operation createAudienceGroup

public createAudienceGroup(CreateAudienceGroupRequest $createAudienceGroupRequest[, string $contentType = self::contentTypes['createAudienceGroup'][0] ]) : CreateAudienceGroupResponse
Parameters
$createAudienceGroupRequest : CreateAudienceGroupRequest

createAudienceGroupRequest (required)

$contentType : string = self::contentTypes['createAudienceGroup'][0]

The value for the Content-Type header. Check self::contentTypes['createAudienceGroup'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

throws
InvalidArgumentException
Return values
CreateAudienceGroupResponse

createAudienceGroupAsync()

Operation createAudienceGroupAsync

public createAudienceGroupAsync(CreateAudienceGroupRequest $createAudienceGroupRequest[, string $contentType = self::contentTypes['createAudienceGroup'][0] ]) : PromiseInterface
Parameters
$createAudienceGroupRequest : CreateAudienceGroupRequest

(required)

$contentType : string = self::contentTypes['createAudienceGroup'][0]

The value for the Content-Type header. Check self::contentTypes['createAudienceGroup'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

createAudienceGroupAsyncWithHttpInfo()

Operation createAudienceGroupAsyncWithHttpInfo

public createAudienceGroupAsyncWithHttpInfo(CreateAudienceGroupRequest $createAudienceGroupRequest[, string $contentType = self::contentTypes['createAudienceGroup'][0] ]) : PromiseInterface
Parameters
$createAudienceGroupRequest : CreateAudienceGroupRequest

(required)

$contentType : string = self::contentTypes['createAudienceGroup'][0]

The value for the Content-Type header. Check self::contentTypes['createAudienceGroup'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

createAudienceGroupRequest()

Create request for operation 'createAudienceGroup'

public createAudienceGroupRequest(CreateAudienceGroupRequest $createAudienceGroupRequest[, string $contentType = self::contentTypes['createAudienceGroup'][0] ]) : Request
Parameters
$createAudienceGroupRequest : CreateAudienceGroupRequest

(required)

$contentType : string = self::contentTypes['createAudienceGroup'][0]

The value for the Content-Type header. Check self::contentTypes['createAudienceGroup'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

createAudienceGroupWithHttpInfo()

Operation createAudienceGroupWithHttpInfo

public createAudienceGroupWithHttpInfo(CreateAudienceGroupRequest $createAudienceGroupRequest[, string $contentType = self::contentTypes['createAudienceGroup'][0] ]) : array<string|int, mixed>
Parameters
$createAudienceGroupRequest : CreateAudienceGroupRequest

(required)

$contentType : string = self::contentTypes['createAudienceGroup'][0]

The value for the Content-Type header. Check self::contentTypes['createAudienceGroup'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of \LINE\Clients\ManageAudience\Model\CreateAudienceGroupResponse, HTTP status code, HTTP response headers (array of strings)

createClickBasedAudienceGroup()

Operation createClickBasedAudienceGroup

public createClickBasedAudienceGroup(CreateClickBasedAudienceGroupRequest $createClickBasedAudienceGroupRequest[, string $contentType = self::contentTypes['createClickBasedAudienceGroup'][0] ]) : CreateClickBasedAudienceGroupResponse
Parameters
$createClickBasedAudienceGroupRequest : CreateClickBasedAudienceGroupRequest

createClickBasedAudienceGroupRequest (required)

$contentType : string = self::contentTypes['createClickBasedAudienceGroup'][0]

The value for the Content-Type header. Check self::contentTypes['createClickBasedAudienceGroup'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

throws
InvalidArgumentException
Return values
CreateClickBasedAudienceGroupResponse

createClickBasedAudienceGroupAsync()

Operation createClickBasedAudienceGroupAsync

public createClickBasedAudienceGroupAsync(CreateClickBasedAudienceGroupRequest $createClickBasedAudienceGroupRequest[, string $contentType = self::contentTypes['createClickBasedAudienceGroup'][0] ]) : PromiseInterface
Parameters
$createClickBasedAudienceGroupRequest : CreateClickBasedAudienceGroupRequest

(required)

$contentType : string = self::contentTypes['createClickBasedAudienceGroup'][0]

The value for the Content-Type header. Check self::contentTypes['createClickBasedAudienceGroup'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

createClickBasedAudienceGroupAsyncWithHttpInfo()

Operation createClickBasedAudienceGroupAsyncWithHttpInfo

public createClickBasedAudienceGroupAsyncWithHttpInfo(CreateClickBasedAudienceGroupRequest $createClickBasedAudienceGroupRequest[, string $contentType = self::contentTypes['createClickBasedAudienceGroup'][0] ]) : PromiseInterface
Parameters
$createClickBasedAudienceGroupRequest : CreateClickBasedAudienceGroupRequest

(required)

$contentType : string = self::contentTypes['createClickBasedAudienceGroup'][0]

The value for the Content-Type header. Check self::contentTypes['createClickBasedAudienceGroup'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

createClickBasedAudienceGroupRequest()

Create request for operation 'createClickBasedAudienceGroup'

public createClickBasedAudienceGroupRequest(CreateClickBasedAudienceGroupRequest $createClickBasedAudienceGroupRequest[, string $contentType = self::contentTypes['createClickBasedAudienceGroup'][0] ]) : Request
Parameters
$createClickBasedAudienceGroupRequest : CreateClickBasedAudienceGroupRequest

(required)

$contentType : string = self::contentTypes['createClickBasedAudienceGroup'][0]

The value for the Content-Type header. Check self::contentTypes['createClickBasedAudienceGroup'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

createClickBasedAudienceGroupWithHttpInfo()

Operation createClickBasedAudienceGroupWithHttpInfo

public createClickBasedAudienceGroupWithHttpInfo(CreateClickBasedAudienceGroupRequest $createClickBasedAudienceGroupRequest[, string $contentType = self::contentTypes['createClickBasedAudienceGroup'][0] ]) : array<string|int, mixed>
Parameters
$createClickBasedAudienceGroupRequest : CreateClickBasedAudienceGroupRequest

(required)

$contentType : string = self::contentTypes['createClickBasedAudienceGroup'][0]

The value for the Content-Type header. Check self::contentTypes['createClickBasedAudienceGroup'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of \LINE\Clients\ManageAudience\Model\CreateClickBasedAudienceGroupResponse, HTTP status code, HTTP response headers (array of strings)

createImpBasedAudienceGroup()

Operation createImpBasedAudienceGroup

public createImpBasedAudienceGroup(CreateImpBasedAudienceGroupRequest $createImpBasedAudienceGroupRequest[, string $contentType = self::contentTypes['createImpBasedAudienceGroup'][0] ]) : CreateImpBasedAudienceGroupResponse
Parameters
$createImpBasedAudienceGroupRequest : CreateImpBasedAudienceGroupRequest

createImpBasedAudienceGroupRequest (required)

$contentType : string = self::contentTypes['createImpBasedAudienceGroup'][0]

The value for the Content-Type header. Check self::contentTypes['createImpBasedAudienceGroup'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

throws
InvalidArgumentException
Return values
CreateImpBasedAudienceGroupResponse

createImpBasedAudienceGroupAsync()

Operation createImpBasedAudienceGroupAsync

public createImpBasedAudienceGroupAsync(CreateImpBasedAudienceGroupRequest $createImpBasedAudienceGroupRequest[, string $contentType = self::contentTypes['createImpBasedAudienceGroup'][0] ]) : PromiseInterface
Parameters
$createImpBasedAudienceGroupRequest : CreateImpBasedAudienceGroupRequest

(required)

$contentType : string = self::contentTypes['createImpBasedAudienceGroup'][0]

The value for the Content-Type header. Check self::contentTypes['createImpBasedAudienceGroup'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

createImpBasedAudienceGroupAsyncWithHttpInfo()

Operation createImpBasedAudienceGroupAsyncWithHttpInfo

public createImpBasedAudienceGroupAsyncWithHttpInfo(CreateImpBasedAudienceGroupRequest $createImpBasedAudienceGroupRequest[, string $contentType = self::contentTypes['createImpBasedAudienceGroup'][0] ]) : PromiseInterface
Parameters
$createImpBasedAudienceGroupRequest : CreateImpBasedAudienceGroupRequest

(required)

$contentType : string = self::contentTypes['createImpBasedAudienceGroup'][0]

The value for the Content-Type header. Check self::contentTypes['createImpBasedAudienceGroup'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

createImpBasedAudienceGroupRequest()

Create request for operation 'createImpBasedAudienceGroup'

public createImpBasedAudienceGroupRequest(CreateImpBasedAudienceGroupRequest $createImpBasedAudienceGroupRequest[, string $contentType = self::contentTypes['createImpBasedAudienceGroup'][0] ]) : Request
Parameters
$createImpBasedAudienceGroupRequest : CreateImpBasedAudienceGroupRequest

(required)

$contentType : string = self::contentTypes['createImpBasedAudienceGroup'][0]

The value for the Content-Type header. Check self::contentTypes['createImpBasedAudienceGroup'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

createImpBasedAudienceGroupWithHttpInfo()

Operation createImpBasedAudienceGroupWithHttpInfo

public createImpBasedAudienceGroupWithHttpInfo(CreateImpBasedAudienceGroupRequest $createImpBasedAudienceGroupRequest[, string $contentType = self::contentTypes['createImpBasedAudienceGroup'][0] ]) : array<string|int, mixed>
Parameters
$createImpBasedAudienceGroupRequest : CreateImpBasedAudienceGroupRequest

(required)

$contentType : string = self::contentTypes['createImpBasedAudienceGroup'][0]

The value for the Content-Type header. Check self::contentTypes['createImpBasedAudienceGroup'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of \LINE\Clients\ManageAudience\Model\CreateImpBasedAudienceGroupResponse, HTTP status code, HTTP response headers (array of strings)

deleteAudienceGroup()

Operation deleteAudienceGroup

public deleteAudienceGroup(int $audienceGroupId[, string $contentType = self::contentTypes['deleteAudienceGroup'][0] ]) : void
Parameters
$audienceGroupId : int

The audience ID. (required)

$contentType : string = self::contentTypes['deleteAudienceGroup'][0]

The value for the Content-Type header. Check self::contentTypes['deleteAudienceGroup'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

throws
InvalidArgumentException
Return values
void

deleteAudienceGroupAsync()

Operation deleteAudienceGroupAsync

public deleteAudienceGroupAsync(int $audienceGroupId[, string $contentType = self::contentTypes['deleteAudienceGroup'][0] ]) : PromiseInterface
Parameters
$audienceGroupId : int

The audience ID. (required)

$contentType : string = self::contentTypes['deleteAudienceGroup'][0]

The value for the Content-Type header. Check self::contentTypes['deleteAudienceGroup'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

deleteAudienceGroupAsyncWithHttpInfo()

Operation deleteAudienceGroupAsyncWithHttpInfo

public deleteAudienceGroupAsyncWithHttpInfo(int $audienceGroupId[, string $contentType = self::contentTypes['deleteAudienceGroup'][0] ]) : PromiseInterface
Parameters
$audienceGroupId : int

The audience ID. (required)

$contentType : string = self::contentTypes['deleteAudienceGroup'][0]

The value for the Content-Type header. Check self::contentTypes['deleteAudienceGroup'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

deleteAudienceGroupRequest()

Create request for operation 'deleteAudienceGroup'

public deleteAudienceGroupRequest(int $audienceGroupId[, string $contentType = self::contentTypes['deleteAudienceGroup'][0] ]) : Request
Parameters
$audienceGroupId : int

The audience ID. (required)

$contentType : string = self::contentTypes['deleteAudienceGroup'][0]

The value for the Content-Type header. Check self::contentTypes['deleteAudienceGroup'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

deleteAudienceGroupWithHttpInfo()

Operation deleteAudienceGroupWithHttpInfo

public deleteAudienceGroupWithHttpInfo(int $audienceGroupId[, string $contentType = self::contentTypes['deleteAudienceGroup'][0] ]) : array<string|int, mixed>
Parameters
$audienceGroupId : int

The audience ID. (required)

$contentType : string = self::contentTypes['deleteAudienceGroup'][0]

The value for the Content-Type header. Check self::contentTypes['deleteAudienceGroup'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of null, HTTP status code, HTTP response headers (array of strings)

getAudienceData()

Operation getAudienceData

public getAudienceData(int $audienceGroupId[, string $contentType = self::contentTypes['getAudienceData'][0] ]) : GetAudienceDataResponse|ErrorResponse
Parameters
$audienceGroupId : int

The audience ID. (required)

$contentType : string = self::contentTypes['getAudienceData'][0]

The value for the Content-Type header. Check self::contentTypes['getAudienceData'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

throws
InvalidArgumentException
Return values
GetAudienceDataResponse|ErrorResponse

getAudienceDataAsync()

Operation getAudienceDataAsync

public getAudienceDataAsync(int $audienceGroupId[, string $contentType = self::contentTypes['getAudienceData'][0] ]) : PromiseInterface
Parameters
$audienceGroupId : int

The audience ID. (required)

$contentType : string = self::contentTypes['getAudienceData'][0]

The value for the Content-Type header. Check self::contentTypes['getAudienceData'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getAudienceDataAsyncWithHttpInfo()

Operation getAudienceDataAsyncWithHttpInfo

public getAudienceDataAsyncWithHttpInfo(int $audienceGroupId[, string $contentType = self::contentTypes['getAudienceData'][0] ]) : PromiseInterface
Parameters
$audienceGroupId : int

The audience ID. (required)

$contentType : string = self::contentTypes['getAudienceData'][0]

The value for the Content-Type header. Check self::contentTypes['getAudienceData'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getAudienceDataRequest()

Create request for operation 'getAudienceData'

public getAudienceDataRequest(int $audienceGroupId[, string $contentType = self::contentTypes['getAudienceData'][0] ]) : Request
Parameters
$audienceGroupId : int

The audience ID. (required)

$contentType : string = self::contentTypes['getAudienceData'][0]

The value for the Content-Type header. Check self::contentTypes['getAudienceData'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getAudienceDataWithHttpInfo()

Operation getAudienceDataWithHttpInfo

public getAudienceDataWithHttpInfo(int $audienceGroupId[, string $contentType = self::contentTypes['getAudienceData'][0] ]) : array<string|int, mixed>
Parameters
$audienceGroupId : int

The audience ID. (required)

$contentType : string = self::contentTypes['getAudienceData'][0]

The value for the Content-Type header. Check self::contentTypes['getAudienceData'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of \LINE\Clients\ManageAudience\Model\GetAudienceDataResponse|\LINE\Clients\ManageAudience\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings)

getAudienceGroups()

Operation getAudienceGroups

public getAudienceGroups(int $page[, string|null $description = null ][, AudienceGroupStatus|null $status = null ][, int|null $size = null ][, bool|null $includesExternalPublicGroups = null ][, AudienceGroupCreateRoute|null $createRoute = null ][, string $contentType = self::contentTypes['getAudienceGroups'][0] ]) : GetAudienceGroupsResponse
Parameters
$page : int

The page to return when getting (paginated) results. Must be 1 or higher. (required)

$description : string|null = null

The name of the audience(s) to return. You can search for partial matches. This is case-insensitive, meaning AUDIENCE and audience are considered identical. If omitted, the name of the audience(s) will not be used as a search criterion. (optional)

$status : AudienceGroupStatus|null = null

The status of the audience(s) to return. If omitted, the status of the audience(s) will not be used as a search criterion. (optional)

$size : int|null = null

The number of audiences per page. Default: 20 Max: 40 (optional)

$includesExternalPublicGroups : bool|null = null

true (default): Get public audiences created in all channels linked to the same bot. false: Get audiences created in the same channel. (optional)

$createRoute : AudienceGroupCreateRoute|null = null

How the audience was created. If omitted, all audiences are included. `OA_MANAGER`: Return only audiences created with LINE Official Account Manager (opens new window). `MESSAGING_API`: Return only audiences created with Messaging API. (optional)

$contentType : string = self::contentTypes['getAudienceGroups'][0]

The value for the Content-Type header. Check self::contentTypes['getAudienceGroups'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

throws
InvalidArgumentException
Return values
GetAudienceGroupsResponse

getAudienceGroupsAsync()

Operation getAudienceGroupsAsync

public getAudienceGroupsAsync(int $page[, string|null $description = null ][, AudienceGroupStatus|null $status = null ][, int|null $size = null ][, bool|null $includesExternalPublicGroups = null ][, AudienceGroupCreateRoute|null $createRoute = null ][, string $contentType = self::contentTypes['getAudienceGroups'][0] ]) : PromiseInterface
Parameters
$page : int

The page to return when getting (paginated) results. Must be 1 or higher. (required)

$description : string|null = null

The name of the audience(s) to return. You can search for partial matches. This is case-insensitive, meaning AUDIENCE and audience are considered identical. If omitted, the name of the audience(s) will not be used as a search criterion. (optional)

$status : AudienceGroupStatus|null = null

The status of the audience(s) to return. If omitted, the status of the audience(s) will not be used as a search criterion. (optional)

$size : int|null = null

The number of audiences per page. Default: 20 Max: 40 (optional)

$includesExternalPublicGroups : bool|null = null

true (default): Get public audiences created in all channels linked to the same bot. false: Get audiences created in the same channel. (optional)

$createRoute : AudienceGroupCreateRoute|null = null

How the audience was created. If omitted, all audiences are included. `OA_MANAGER`: Return only audiences created with LINE Official Account Manager (opens new window). `MESSAGING_API`: Return only audiences created with Messaging API. (optional)

$contentType : string = self::contentTypes['getAudienceGroups'][0]

The value for the Content-Type header. Check self::contentTypes['getAudienceGroups'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getAudienceGroupsAsyncWithHttpInfo()

Operation getAudienceGroupsAsyncWithHttpInfo

public getAudienceGroupsAsyncWithHttpInfo(int $page[, string|null $description = null ][, AudienceGroupStatus|null $status = null ][, int|null $size = null ][, bool|null $includesExternalPublicGroups = null ][, AudienceGroupCreateRoute|null $createRoute = null ][, string $contentType = self::contentTypes['getAudienceGroups'][0] ]) : PromiseInterface
Parameters
$page : int

The page to return when getting (paginated) results. Must be 1 or higher. (required)

$description : string|null = null

The name of the audience(s) to return. You can search for partial matches. This is case-insensitive, meaning AUDIENCE and audience are considered identical. If omitted, the name of the audience(s) will not be used as a search criterion. (optional)

$status : AudienceGroupStatus|null = null

The status of the audience(s) to return. If omitted, the status of the audience(s) will not be used as a search criterion. (optional)

$size : int|null = null

The number of audiences per page. Default: 20 Max: 40 (optional)

$includesExternalPublicGroups : bool|null = null

true (default): Get public audiences created in all channels linked to the same bot. false: Get audiences created in the same channel. (optional)

$createRoute : AudienceGroupCreateRoute|null = null

How the audience was created. If omitted, all audiences are included. `OA_MANAGER`: Return only audiences created with LINE Official Account Manager (opens new window). `MESSAGING_API`: Return only audiences created with Messaging API. (optional)

$contentType : string = self::contentTypes['getAudienceGroups'][0]

The value for the Content-Type header. Check self::contentTypes['getAudienceGroups'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getAudienceGroupsRequest()

Create request for operation 'getAudienceGroups'

public getAudienceGroupsRequest(int $page[, string|null $description = null ][, AudienceGroupStatus|null $status = null ][, int|null $size = null ][, bool|null $includesExternalPublicGroups = null ][, AudienceGroupCreateRoute|null $createRoute = null ][, string $contentType = self::contentTypes['getAudienceGroups'][0] ]) : Request
Parameters
$page : int

The page to return when getting (paginated) results. Must be 1 or higher. (required)

$description : string|null = null

The name of the audience(s) to return. You can search for partial matches. This is case-insensitive, meaning AUDIENCE and audience are considered identical. If omitted, the name of the audience(s) will not be used as a search criterion. (optional)

$status : AudienceGroupStatus|null = null

The status of the audience(s) to return. If omitted, the status of the audience(s) will not be used as a search criterion. (optional)

$size : int|null = null

The number of audiences per page. Default: 20 Max: 40 (optional)

$includesExternalPublicGroups : bool|null = null

true (default): Get public audiences created in all channels linked to the same bot. false: Get audiences created in the same channel. (optional)

$createRoute : AudienceGroupCreateRoute|null = null

How the audience was created. If omitted, all audiences are included. `OA_MANAGER`: Return only audiences created with LINE Official Account Manager (opens new window). `MESSAGING_API`: Return only audiences created with Messaging API. (optional)

$contentType : string = self::contentTypes['getAudienceGroups'][0]

The value for the Content-Type header. Check self::contentTypes['getAudienceGroups'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getAudienceGroupsWithHttpInfo()

Operation getAudienceGroupsWithHttpInfo

public getAudienceGroupsWithHttpInfo(int $page[, string|null $description = null ][, AudienceGroupStatus|null $status = null ][, int|null $size = null ][, bool|null $includesExternalPublicGroups = null ][, AudienceGroupCreateRoute|null $createRoute = null ][, string $contentType = self::contentTypes['getAudienceGroups'][0] ]) : array<string|int, mixed>
Parameters
$page : int

The page to return when getting (paginated) results. Must be 1 or higher. (required)

$description : string|null = null

The name of the audience(s) to return. You can search for partial matches. This is case-insensitive, meaning AUDIENCE and audience are considered identical. If omitted, the name of the audience(s) will not be used as a search criterion. (optional)

$status : AudienceGroupStatus|null = null

The status of the audience(s) to return. If omitted, the status of the audience(s) will not be used as a search criterion. (optional)

$size : int|null = null

The number of audiences per page. Default: 20 Max: 40 (optional)

$includesExternalPublicGroups : bool|null = null

true (default): Get public audiences created in all channels linked to the same bot. false: Get audiences created in the same channel. (optional)

$createRoute : AudienceGroupCreateRoute|null = null

How the audience was created. If omitted, all audiences are included. `OA_MANAGER`: Return only audiences created with LINE Official Account Manager (opens new window). `MESSAGING_API`: Return only audiences created with Messaging API. (optional)

$contentType : string = self::contentTypes['getAudienceGroups'][0]

The value for the Content-Type header. Check self::contentTypes['getAudienceGroups'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of \LINE\Clients\ManageAudience\Model\GetAudienceGroupsResponse, HTTP status code, HTTP response headers (array of strings)

getHostIndex()

Get the host index

public getHostIndex() : int
Return values
int

Host index

getSharedAudienceData()

Operation getSharedAudienceData

public getSharedAudienceData(int $audienceGroupId[, string $contentType = self::contentTypes['getSharedAudienceData'][0] ]) : GetSharedAudienceDataResponse|ErrorResponse
Parameters
$audienceGroupId : int

The audience ID. (required)

$contentType : string = self::contentTypes['getSharedAudienceData'][0]

The value for the Content-Type header. Check self::contentTypes['getSharedAudienceData'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

throws
InvalidArgumentException
Return values
GetSharedAudienceDataResponse|ErrorResponse

getSharedAudienceDataAsync()

Operation getSharedAudienceDataAsync

public getSharedAudienceDataAsync(int $audienceGroupId[, string $contentType = self::contentTypes['getSharedAudienceData'][0] ]) : PromiseInterface
Parameters
$audienceGroupId : int

The audience ID. (required)

$contentType : string = self::contentTypes['getSharedAudienceData'][0]

The value for the Content-Type header. Check self::contentTypes['getSharedAudienceData'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getSharedAudienceDataAsyncWithHttpInfo()

Operation getSharedAudienceDataAsyncWithHttpInfo

public getSharedAudienceDataAsyncWithHttpInfo(int $audienceGroupId[, string $contentType = self::contentTypes['getSharedAudienceData'][0] ]) : PromiseInterface
Parameters
$audienceGroupId : int

The audience ID. (required)

$contentType : string = self::contentTypes['getSharedAudienceData'][0]

The value for the Content-Type header. Check self::contentTypes['getSharedAudienceData'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getSharedAudienceDataRequest()

Create request for operation 'getSharedAudienceData'

public getSharedAudienceDataRequest(int $audienceGroupId[, string $contentType = self::contentTypes['getSharedAudienceData'][0] ]) : Request
Parameters
$audienceGroupId : int

The audience ID. (required)

$contentType : string = self::contentTypes['getSharedAudienceData'][0]

The value for the Content-Type header. Check self::contentTypes['getSharedAudienceData'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getSharedAudienceDataWithHttpInfo()

Operation getSharedAudienceDataWithHttpInfo

public getSharedAudienceDataWithHttpInfo(int $audienceGroupId[, string $contentType = self::contentTypes['getSharedAudienceData'][0] ]) : array<string|int, mixed>
Parameters
$audienceGroupId : int

The audience ID. (required)

$contentType : string = self::contentTypes['getSharedAudienceData'][0]

The value for the Content-Type header. Check self::contentTypes['getSharedAudienceData'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of \LINE\Clients\ManageAudience\Model\GetSharedAudienceDataResponse|\LINE\Clients\ManageAudience\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings)

getSharedAudienceGroups()

Operation getSharedAudienceGroups

public getSharedAudienceGroups(int $page[, string|null $description = null ][, AudienceGroupStatus|null $status = null ][, int|null $size = null ][, AudienceGroupCreateRoute|null $createRoute = null ][, bool|null $includesOwnedAudienceGroups = false ][, string $contentType = self::contentTypes['getSharedAudienceGroups'][0] ]) : GetSharedAudienceGroupsResponse
Parameters
$page : int

The page to return when getting (paginated) results. Must be 1 or higher. (required)

$description : string|null = null

The name of the audience(s) to return. You can search for partial matches. This is case-insensitive, meaning AUDIENCE and audience are considered identical. If omitted, the name of the audience(s) will not be used as a search criterion. (optional)

$status : AudienceGroupStatus|null = null

The status of the audience(s) to return. If omitted, the status of the audience(s) will not be used as a search criterion. (optional)

$size : int|null = null

The number of audiences per page. Default: 20 Max: 40 (optional)

$createRoute : AudienceGroupCreateRoute|null = null

How the audience was created. If omitted, all audiences are included. `OA_MANAGER`: Return only audiences created with LINE Official Account Manager (opens new window). `MESSAGING_API`: Return only audiences created with Messaging API. (optional)

$includesOwnedAudienceGroups : bool|null = false

true: Include audienceGroups owned by LINE Official Account Manager false: Respond only audienceGroups shared by Business Manager (optional, default to false)

$contentType : string = self::contentTypes['getSharedAudienceGroups'][0]

The value for the Content-Type header. Check self::contentTypes['getSharedAudienceGroups'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

throws
InvalidArgumentException
Return values
GetSharedAudienceGroupsResponse

getSharedAudienceGroupsAsync()

Operation getSharedAudienceGroupsAsync

public getSharedAudienceGroupsAsync(int $page[, string|null $description = null ][, AudienceGroupStatus|null $status = null ][, int|null $size = null ][, AudienceGroupCreateRoute|null $createRoute = null ][, bool|null $includesOwnedAudienceGroups = false ][, string $contentType = self::contentTypes['getSharedAudienceGroups'][0] ]) : PromiseInterface
Parameters
$page : int

The page to return when getting (paginated) results. Must be 1 or higher. (required)

$description : string|null = null

The name of the audience(s) to return. You can search for partial matches. This is case-insensitive, meaning AUDIENCE and audience are considered identical. If omitted, the name of the audience(s) will not be used as a search criterion. (optional)

$status : AudienceGroupStatus|null = null

The status of the audience(s) to return. If omitted, the status of the audience(s) will not be used as a search criterion. (optional)

$size : int|null = null

The number of audiences per page. Default: 20 Max: 40 (optional)

$createRoute : AudienceGroupCreateRoute|null = null

How the audience was created. If omitted, all audiences are included. `OA_MANAGER`: Return only audiences created with LINE Official Account Manager (opens new window). `MESSAGING_API`: Return only audiences created with Messaging API. (optional)

$includesOwnedAudienceGroups : bool|null = false

true: Include audienceGroups owned by LINE Official Account Manager false: Respond only audienceGroups shared by Business Manager (optional, default to false)

$contentType : string = self::contentTypes['getSharedAudienceGroups'][0]

The value for the Content-Type header. Check self::contentTypes['getSharedAudienceGroups'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getSharedAudienceGroupsAsyncWithHttpInfo()

Operation getSharedAudienceGroupsAsyncWithHttpInfo

public getSharedAudienceGroupsAsyncWithHttpInfo(int $page[, string|null $description = null ][, AudienceGroupStatus|null $status = null ][, int|null $size = null ][, AudienceGroupCreateRoute|null $createRoute = null ][, bool|null $includesOwnedAudienceGroups = false ][, string $contentType = self::contentTypes['getSharedAudienceGroups'][0] ]) : PromiseInterface
Parameters
$page : int

The page to return when getting (paginated) results. Must be 1 or higher. (required)

$description : string|null = null

The name of the audience(s) to return. You can search for partial matches. This is case-insensitive, meaning AUDIENCE and audience are considered identical. If omitted, the name of the audience(s) will not be used as a search criterion. (optional)

$status : AudienceGroupStatus|null = null

The status of the audience(s) to return. If omitted, the status of the audience(s) will not be used as a search criterion. (optional)

$size : int|null = null

The number of audiences per page. Default: 20 Max: 40 (optional)

$createRoute : AudienceGroupCreateRoute|null = null

How the audience was created. If omitted, all audiences are included. `OA_MANAGER`: Return only audiences created with LINE Official Account Manager (opens new window). `MESSAGING_API`: Return only audiences created with Messaging API. (optional)

$includesOwnedAudienceGroups : bool|null = false

true: Include audienceGroups owned by LINE Official Account Manager false: Respond only audienceGroups shared by Business Manager (optional, default to false)

$contentType : string = self::contentTypes['getSharedAudienceGroups'][0]

The value for the Content-Type header. Check self::contentTypes['getSharedAudienceGroups'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getSharedAudienceGroupsRequest()

Create request for operation 'getSharedAudienceGroups'

public getSharedAudienceGroupsRequest(int $page[, string|null $description = null ][, AudienceGroupStatus|null $status = null ][, int|null $size = null ][, AudienceGroupCreateRoute|null $createRoute = null ][, bool|null $includesOwnedAudienceGroups = false ][, string $contentType = self::contentTypes['getSharedAudienceGroups'][0] ]) : Request
Parameters
$page : int

The page to return when getting (paginated) results. Must be 1 or higher. (required)

$description : string|null = null

The name of the audience(s) to return. You can search for partial matches. This is case-insensitive, meaning AUDIENCE and audience are considered identical. If omitted, the name of the audience(s) will not be used as a search criterion. (optional)

$status : AudienceGroupStatus|null = null

The status of the audience(s) to return. If omitted, the status of the audience(s) will not be used as a search criterion. (optional)

$size : int|null = null

The number of audiences per page. Default: 20 Max: 40 (optional)

$createRoute : AudienceGroupCreateRoute|null = null

How the audience was created. If omitted, all audiences are included. `OA_MANAGER`: Return only audiences created with LINE Official Account Manager (opens new window). `MESSAGING_API`: Return only audiences created with Messaging API. (optional)

$includesOwnedAudienceGroups : bool|null = false

true: Include audienceGroups owned by LINE Official Account Manager false: Respond only audienceGroups shared by Business Manager (optional, default to false)

$contentType : string = self::contentTypes['getSharedAudienceGroups'][0]

The value for the Content-Type header. Check self::contentTypes['getSharedAudienceGroups'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getSharedAudienceGroupsWithHttpInfo()

Operation getSharedAudienceGroupsWithHttpInfo

public getSharedAudienceGroupsWithHttpInfo(int $page[, string|null $description = null ][, AudienceGroupStatus|null $status = null ][, int|null $size = null ][, AudienceGroupCreateRoute|null $createRoute = null ][, bool|null $includesOwnedAudienceGroups = false ][, string $contentType = self::contentTypes['getSharedAudienceGroups'][0] ]) : array<string|int, mixed>
Parameters
$page : int

The page to return when getting (paginated) results. Must be 1 or higher. (required)

$description : string|null = null

The name of the audience(s) to return. You can search for partial matches. This is case-insensitive, meaning AUDIENCE and audience are considered identical. If omitted, the name of the audience(s) will not be used as a search criterion. (optional)

$status : AudienceGroupStatus|null = null

The status of the audience(s) to return. If omitted, the status of the audience(s) will not be used as a search criterion. (optional)

$size : int|null = null

The number of audiences per page. Default: 20 Max: 40 (optional)

$createRoute : AudienceGroupCreateRoute|null = null

How the audience was created. If omitted, all audiences are included. `OA_MANAGER`: Return only audiences created with LINE Official Account Manager (opens new window). `MESSAGING_API`: Return only audiences created with Messaging API. (optional)

$includesOwnedAudienceGroups : bool|null = false

true: Include audienceGroups owned by LINE Official Account Manager false: Respond only audienceGroups shared by Business Manager (optional, default to false)

$contentType : string = self::contentTypes['getSharedAudienceGroups'][0]

The value for the Content-Type header. Check self::contentTypes['getSharedAudienceGroups'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of \LINE\Clients\ManageAudience\Model\GetSharedAudienceGroupsResponse, HTTP status code, HTTP response headers (array of strings)

setHostIndex()

Set the host index

public setHostIndex(int $hostIndex) : void
Parameters
$hostIndex : int

Host index (required)

Return values
void

updateAudienceGroupDescription()

Operation updateAudienceGroupDescription

public updateAudienceGroupDescription(int $audienceGroupId, UpdateAudienceGroupDescriptionRequest $updateAudienceGroupDescriptionRequest[, string $contentType = self::contentTypes['updateAudienceGroupDescription'][0] ]) : void
Parameters
$audienceGroupId : int

The audience ID. (required)

$updateAudienceGroupDescriptionRequest : UpdateAudienceGroupDescriptionRequest

updateAudienceGroupDescriptionRequest (required)

$contentType : string = self::contentTypes['updateAudienceGroupDescription'][0]

The value for the Content-Type header. Check self::contentTypes['updateAudienceGroupDescription'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

throws
InvalidArgumentException
Return values
void

updateAudienceGroupDescriptionAsync()

Operation updateAudienceGroupDescriptionAsync

public updateAudienceGroupDescriptionAsync(int $audienceGroupId, UpdateAudienceGroupDescriptionRequest $updateAudienceGroupDescriptionRequest[, string $contentType = self::contentTypes['updateAudienceGroupDescription'][0] ]) : PromiseInterface
Parameters
$audienceGroupId : int

The audience ID. (required)

$updateAudienceGroupDescriptionRequest : UpdateAudienceGroupDescriptionRequest

(required)

$contentType : string = self::contentTypes['updateAudienceGroupDescription'][0]

The value for the Content-Type header. Check self::contentTypes['updateAudienceGroupDescription'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

updateAudienceGroupDescriptionAsyncWithHttpInfo()

Operation updateAudienceGroupDescriptionAsyncWithHttpInfo

public updateAudienceGroupDescriptionAsyncWithHttpInfo(int $audienceGroupId, UpdateAudienceGroupDescriptionRequest $updateAudienceGroupDescriptionRequest[, string $contentType = self::contentTypes['updateAudienceGroupDescription'][0] ]) : PromiseInterface
Parameters
$audienceGroupId : int

The audience ID. (required)

$updateAudienceGroupDescriptionRequest : UpdateAudienceGroupDescriptionRequest

(required)

$contentType : string = self::contentTypes['updateAudienceGroupDescription'][0]

The value for the Content-Type header. Check self::contentTypes['updateAudienceGroupDescription'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

updateAudienceGroupDescriptionRequest()

Create request for operation 'updateAudienceGroupDescription'

public updateAudienceGroupDescriptionRequest(int $audienceGroupId, UpdateAudienceGroupDescriptionRequest $updateAudienceGroupDescriptionRequest[, string $contentType = self::contentTypes['updateAudienceGroupDescription'][0] ]) : Request
Parameters
$audienceGroupId : int

The audience ID. (required)

$updateAudienceGroupDescriptionRequest : UpdateAudienceGroupDescriptionRequest

(required)

$contentType : string = self::contentTypes['updateAudienceGroupDescription'][0]

The value for the Content-Type header. Check self::contentTypes['updateAudienceGroupDescription'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

updateAudienceGroupDescriptionWithHttpInfo()

Operation updateAudienceGroupDescriptionWithHttpInfo

public updateAudienceGroupDescriptionWithHttpInfo(int $audienceGroupId, UpdateAudienceGroupDescriptionRequest $updateAudienceGroupDescriptionRequest[, string $contentType = self::contentTypes['updateAudienceGroupDescription'][0] ]) : array<string|int, mixed>
Parameters
$audienceGroupId : int

The audience ID. (required)

$updateAudienceGroupDescriptionRequest : UpdateAudienceGroupDescriptionRequest

(required)

$contentType : string = self::contentTypes['updateAudienceGroupDescription'][0]

The value for the Content-Type header. Check self::contentTypes['updateAudienceGroupDescription'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of null, HTTP status code, HTTP response headers (array of strings)

createHttpClientOption()

Create http client option

protected createHttpClientOption() : array<string|int, mixed>
Tags
throws
RuntimeException

on file opening failure

Return values
array<string|int, mixed>

of http client options

Search results