CampaignAudience
Contains the methods used to manage a campaign audience association.
Methods
| Method Name | Return Type | Description |
|---|---|---|
| bidding | AudienceBidding | Gets the methods used to manage this association's bid modifier. |
| enable | void | Enables this association. |
| getAudienceId | string | Gets the associated audience's ID. |
| getCampaign | Campaign | Get this association's campaign. |
| getEntityType | string | Gets the entity's type, which is CampaignAudience. |
| getId | string | Gets the ID that uniquely identifies this association. |
| getName | string | Gets the associated audience's name. |
| getStats | Stats | Gets this campaign audience's performance data. |
| isEnabled | Boolean | Gets a Boolean value that indicates whether this association is enabled. |
| isPaused | Boolean | Gets a Boolean value that indicates whether this association is paused. |
| pause | void | Pauses this association. |
| remove | void | Removes this association. |
bidding
Gets the methods used to manage this association's bid modifier.
Returns
| Type | Description |
|---|---|
| AudienceBidding | Contains the methods used to manage an audience's bid modifier. |
enable
Enables this association.
Returns
| Type | Description |
|---|---|
| void | Returns nothing. |
getAudienceId
Gets the associated audience's ID.
Returns
| Type | Description |
|---|---|
| string | The associated audience's ID. |
getCampaign
Get this association's campaign.
Returns
| Type | Description |
|---|---|
| Campaign | The association's campaign. |
getEntityType
Returns this entity's type.
Returns
| Type | Description |
|---|---|
| string | This entity's type, which is CampaignAudience. |
getId
Gets the ID that uniquely identifies this association.
Returns
| Type | Description |
|---|---|
| string | The ID that uniquely identifies this association. |
getName
Gets the audience's name.
Returns
| Type | Description |
|---|---|
| string | The audience's name. |
getStats
Gets this campaign audience's performance data.
To call this method, you must include one of the forDateRange methods in the campaign audience selector's chain.
Returns
| Type | Description |
|---|---|
| Stats | The campaign audience's performance data. |
isEnabled
Gets a Boolean value that indicates whether this association is enabled.
Returns
| Type | Description |
|---|---|
| Boolean | Is true if this association is enabled; otherwise, false. |
isPaused
Gets a Boolean value that indicates whether this association is paused.
Returns
| Type | Description |
|---|---|
| Boolean | Is true if this association is paused; otherwise, false. |
pause
Pauses this association.
Returns
| Type | Description |
|---|---|
| void | Returns nothing. |
remove
Removes this association.
Returns
| Type | Description |
|---|---|
| void | Returns nothing. |