manage_audience

type AddAudienceToAudienceGroupRequest struct {

	/**
	 * The audience ID.
	 */
	AudienceGroupId int64 `json:"audienceGroupId"`

	/**
	 * The audience's name.
	 */
	UploadDescription string `json:"uploadDescription,omitempty"`

	/**
	 * An array of up to 10,000 user IDs or IFAs.
	 */
	Audiences []Audience `json:"audiences,omitempty"`
}

type Audience struct {

	/**
	 * A user ID or IFA. You can specify an empty array.
	 */
	Id string `json:"id,omitempty"`
}

type AudienceGroup struct {

	/**
	 * The audience ID.
	 */
	AudienceGroupId int64 `json:"audienceGroupId"`

	/**
	 * Get Type
	 */
	Type AudienceGroupType `json:"type,omitempty"`

	/**
	 * The audience's name.
	 */
	Description string `json:"description,omitempty"`

	/**
	 * Get Status
	 */
	Status AudienceGroupStatus `json:"status,omitempty"`

	/**
	 * Get FailedType
	 */
	FailedType AudienceGroupFailedType `json:"failedType,omitempty"`

	/**
	 * The number of users included in the audience.
	 */
	AudienceCount int64 `json:"audienceCount"`

	/**
	 * When the audience was created (in UNIX time).
	 */
	Created int64 `json:"created"`

	/**
	 * The request ID that was specified when the audience was created. This is only included when `audienceGroup.type` is CLICK or IMP.
	 */
	RequestId string `json:"requestId,omitempty"`

	/**
	 * The URL that was specified when the audience was created. This is only included when `audienceGroup.type` is CLICK and link URL is specified.
	 */
	ClickUrl string `json:"clickUrl,omitempty"`

	/**
	 * The value indicating the type of account to be sent, as specified when creating the audience for uploading user IDs.
	 */
	IsIfaAudience bool `json:"isIfaAudience"`

	/**
	 * Get Permission
	 */
	Permission AudienceGroupPermission `json:"permission,omitempty"`

	/**
	 * Get CreateRoute
	 */
	CreateRoute AudienceGroupCreateRoute `json:"createRoute,omitempty"`
}

type AudienceGroupAuthorityLevel string

type AudienceGroupCreateRoute string

type AudienceGroupFailedType string

type AudienceGroupJob struct {

	/**
	 * A job ID.
	 */
	AudienceGroupJobId int64 `json:"audienceGroupJobId"`

	/**
	 * An audience ID.
	 */
	AudienceGroupId int64 `json:"audienceGroupId"`

	/**
	 * The job's description.
	 */
	Description string `json:"description,omitempty"`

	/**
	 * Get Type
	 */
	Type AudienceGroupJobType `json:"type,omitempty"`

	/**
	 * Get JobStatus
	 */
	JobStatus AudienceGroupJobStatus `json:"jobStatus,omitempty"`

	/**
	 * Get FailedType
	 */
	FailedType AudienceGroupJobFailedType `json:"failedType,omitempty"`

	/**
	 * The number of accounts (recipients) that were added or removed.
	 */
	AudienceCount int64 `json:"audienceCount"`

	/**
	 * When the job was created (in UNIX time).
	 */
	Created int64 `json:"created"`
}

type AudienceGroupJobFailedType string

type AudienceGroupJobStatus string

type AudienceGroupJobType string

type AudienceGroupPermission string

type AudienceGroupStatus string

type AudienceGroupType string

type CreateAudienceGroupRequest struct {

	/**
	 * The audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120
	 */
	Description string `json:"description,omitempty"`

	/**
	 * To specify recipients by IFAs: set true. To specify recipients by user IDs: set false or omit isIfaAudience property.
	 */
	IsIfaAudience bool `json:"isIfaAudience"`

	/**
	 * The description to register for the job (in jobs[].description).
	 */
	UploadDescription string `json:"uploadDescription,omitempty"`

	/**
	 * An array of user IDs or IFAs. Max number: 10,000
	 */
	Audiences []Audience `json:"audiences,omitempty"`
}

type CreateAudienceGroupResponse struct {

	/**
	 * The audience ID.
	 */
	AudienceGroupId int64 `json:"audienceGroupId"`

	/**
	 * How the audience was created.  `MESSAGING_API`: An audience created with Messaging API.
	 */
	CreateRoute CreateAudienceGroupResponseCREATE_ROUTE `json:"createRoute,omitempty"`

	/**
	 * Get Type
	 */
	Type AudienceGroupType `json:"type,omitempty"`

	/**
	 * The audience's name.
	 */
	Description string `json:"description,omitempty"`

	/**
	 * When the audience was created (in UNIX time).
	 */
	Created int64 `json:"created"`

	/**
	 * Audience's update permission. Audiences linked to the same channel will be READ_WRITE.  `READ`: Can use only. `READ_WRITE`: Can use and update.
	 */
	Permission CreateAudienceGroupResponsePERMISSION `json:"permission,omitempty"`

	/**
	 * Time of audience expiration. Only returned for specific audiences.
	 */
	ExpireTimestamp float32 `json:"expireTimestamp"`

	/**
	 * The value indicating the type of account to be sent, as specified when creating the audience for uploading user IDs. One of:  `true`: Accounts are specified with IFAs. `false` (default): Accounts are specified with user IDs.
	 */
	IsIfaAudience bool `json:"isIfaAudience"`
}

type CreateAudienceGroupResponseCREATE_ROUTE string

type CreateAudienceGroupResponsePERMISSION string

type CreateClickBasedAudienceGroupRequest struct {

	/**
	 * The audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120
	 */
	Description string `json:"description,omitempty"`

	/**
	 * The request ID of a broadcast or narrowcast message sent in the past 60 days. Each Messaging API request has a request ID.
	 */
	RequestId string `json:"requestId,omitempty"`

	/**
	 * The URL clicked by the user. If empty, users who clicked any URL in the message are added to the list of recipients. Max character limit: 2,000
	 */
	ClickUrl string `json:"clickUrl,omitempty"`
}

type CreateClickBasedAudienceGroupResponse struct {

	/**
	 * The audience ID.
	 */
	AudienceGroupId int64 `json:"audienceGroupId"`

	/**
	 * Get Type
	 */
	Type AudienceGroupType `json:"type,omitempty"`

	/**
	 * The audience's name.
	 */
	Description string `json:"description,omitempty"`

	/**
	 * When the audience was created (in UNIX time).
	 */
	Created int64 `json:"created"`

	/**
	 * The request ID that was specified when the audience was created.
	 */
	RequestId string `json:"requestId,omitempty"`

	/**
	 * The URL that was specified when the audience was created.
	 */
	ClickUrl string `json:"clickUrl,omitempty"`

	/**
	 * How the audience was created. `MESSAGING_API`: An audience created with Messaging API.
	 */
	CreateRoute CreateClickBasedAudienceGroupResponseCREATE_ROUTE `json:"createRoute,omitempty"`

	/**
	 * Audience's update permission. Audiences linked to the same channel will be READ_WRITE.  - `READ`: Can use only. - `READ_WRITE`: Can use and update.
	 */
	Permission CreateClickBasedAudienceGroupResponsePERMISSION `json:"permission,omitempty"`

	/**
	 * Time of audience expiration. Only returned for specific audiences.
	 */
	ExpireTimestamp int64 `json:"expireTimestamp"`

	/**
	 * The value indicating the type of account to be sent, as specified when creating the audience for uploading user IDs. One of:  true: Accounts are specified with IFAs. false (default): Accounts are specified with user IDs.
	 */
	IsIfaAudience bool `json:"isIfaAudience"`
}

type CreateClickBasedAudienceGroupResponseCREATE_ROUTE string

type CreateClickBasedAudienceGroupResponsePERMISSION string

type CreateImpBasedAudienceGroupRequest struct {

	/**
	 * The audience's name. This is case-insensitive, meaning `AUDIENCE` and `audience` are considered identical. Max character limit: 120
	 */
	Description string `json:"description,omitempty"`

	/**
	 * The request ID of a broadcast or narrowcast message sent in the past 60 days. Each Messaging API request has a request ID.
	 */
	RequestId string `json:"requestId,omitempty"`
}

type CreateImpBasedAudienceGroupResponse struct {

	/**
	 * The audience ID.
	 */
	AudienceGroupId int64 `json:"audienceGroupId"`

	/**
	 * Get Type
	 */
	Type AudienceGroupType `json:"type,omitempty"`

	/**
	 * The audience's name.
	 */
	Description string `json:"description,omitempty"`

	/**
	 * When the audience was created (in UNIX time).
	 */
	Created int64 `json:"created"`

	/**
	 * The request ID that was specified when the audience was created.
	 */
	RequestId string `json:"requestId,omitempty"`
}

type ErrorDetail struct {

	/**
	 * Details of the error. Not included in the response under certain situations.
	 */
	Message string `json:"message,omitempty"`

	/**
	 * Location of where the error occurred. Returns the JSON field name or query parameter name of the request. Not included in the response under certain situations.
	 */
	Property string `json:"property,omitempty"`
}

type ErrorResponse struct {

	/**
	 * Message containing information about the error. (Required)
	 */
	Message string `json:"message"`

	/**
	 * An array of error details. If the array is empty, this property will not be included in the response.
	 */
	Details []ErrorDetail `json:"details,omitempty"`
}

type GetAudienceDataResponse struct {

	/**
	 * Get AudienceGroup
	 */
	AudienceGroup *AudienceGroup `json:"audienceGroup,omitempty"`

	/**
	 * An array of jobs. This array is used to keep track of each attempt to add new user IDs or IFAs to an audience for uploading user IDs. Empty array is returned for any other type of audience. Max: 50
	 */
	Jobs []AudienceGroupJob `json:"jobs,omitempty"`
}

type GetAudienceGroupAuthorityLevelResponse struct {

	/**
	 * Get AuthorityLevel
	 */
	AuthorityLevel AudienceGroupAuthorityLevel `json:"authorityLevel,omitempty"`
}

type GetAudienceGroupsResponse struct {

	/**
	 * An array of audience data. If there are no audiences that match the specified filter, an empty array will be returned.
	 */
	AudienceGroups []AudienceGroup `json:"audienceGroups,omitempty"`

	/**
	 * true when this is not the last page.
	 */
	HasNextPage bool `json:"hasNextPage"`

	/**
	 * The total number of audiences that can be returned with the specified filter.
	 */
	TotalCount int64 `json:"totalCount"`

	/**
	 * Of the audiences you can get with the specified filter, the number of audiences with the update permission set to READ_WRITE.
	 */
	ReadWriteAudienceGroupTotalCount int64 `json:"readWriteAudienceGroupTotalCount"`

	/**
	 * The current page number.
	 */
	Page int64 `json:"page"`

	/**
	 * The maximum number of audiences on the current page.
	 */
	Size int64 `json:"size"`
}

type ManageAudienceAPI struct {
	// contains filtered or unexported fields
}

type ManageAudienceAPIOption func(*ManageAudienceAPI) error

type ManageAudienceBlobAPI struct {
	// contains filtered or unexported fields
}

type ManageAudienceBlobAPIOption func(*ManageAudienceBlobAPI) error

type UpdateAudienceGroupAuthorityLevelRequest struct {

	/**
	 * Get AuthorityLevel
	 */
	AuthorityLevel AudienceGroupAuthorityLevel `json:"authorityLevel,omitempty"`
}

type UpdateAudienceGroupDescriptionRequest struct {

	/**
	 * The audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120
	 */
	Description string `json:"description,omitempty"`
}