openapi: 3.0.0 info: title: Moloco Ads Campaign Management API description: Moloco Ads Campaign Management API provides functionalities for Moloco Ads Campaigns. version: '1.10' contact: name: Moloco Inc. url: https://www.moloco.com tags: - name: DspApi paths: /cm/v1/ad-accounts: get: summary: List up AdAccounts. description: List all AdAccounts accessible by the current user on the current Workplace. operationId: DspApi_ListAdAccounts responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesListAdAccountsResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesListAdAccountsError' tags: - AdAccount post: summary: Create a new AdAccount. description: Create a new AdAccount on the Workplace. operationId: DspApi_CreateAdAccount responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesCreateAdAccountResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesCreateAdAccountError' requestBody: content: application/json: schema: $ref: '#/components/schemas/dspAdAccount' description: The AdAccount data to be created. required: true tags: - AdAccount /cm/v1/ad-accounts/{ad_account_id}: get: summary: Read an existing AdAccount. description: Read an existing AdAccount. operationId: DspApi_ReadAdAccount responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesReadAdAccountResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesReadAdAccountError' parameters: - name: ad_account_id description: The ID of the AdAccount to be retrieved. in: path required: true schema: type: string tags: - AdAccount delete: summary: Delete an existing AdAccount. description: Delete an AdAccount from the current Workplace. operationId: DspApi_DeleteAdAccount responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesDeleteAdAccountResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesDeleteAdAccountError' parameters: - name: ad_account_id description: The AdAccount ID to be deleted. in: path required: true schema: type: string tags: - AdAccount put: summary: Update an existing AdAccount. description: Update an existing AdAccount. operationId: DspApi_UpdateAdAccount responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesUpdateAdAccountResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesUpdateAdAccountError' parameters: - name: ad_account_id description: The ID of the AdAccount. in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/dspAdAccount' description: The AdAccount data to be updated. required: true tags: - AdAccount /cm/v1/ad-groups: get: summary: List up AdGroups. description: List up all AdGroups of the Campaign. operationId: DspApi_ListAdGroups responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesListAdGroupsResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesListAdGroupsError' parameters: - name: ad_account_id description: The AdAccount ID to which AdGroups belong to. in: query required: true schema: type: string - name: product_id description: The Product ID to which AdGroups belong to. in: query required: false schema: type: string - name: campaign_id description: 'The Campaign ID which AdGroups belong to. If not specified, response will contains all AdGroups under the Product.' in: query required: false schema: type: string - name: inquiry_option description: "InquiryOption to specify which information to retrieve.\n\n - INQUIRY_ENTITY: Only the target entity\ \ itself is returned in response.\nThis InquiryOption is faster than other options as it reads the single entity\ \ from the database.\n - INQUIRY_OVERVIEW: The target entity's overview information is returned in response.\nIn\ \ general, the overview information includes the brief content of the target entity and its related entities.\n\ This InquiryOption is slower than INQUIRY_ENTITY but the returned data size is usually smaller than that.\n - INQUIRY_ALL:\ \ The target entity and its summary information is returned in response.\nThis InquiryOption is equivalent to INQUIRY_ENTITY\ \ + INQUIRY_OVERVIEW, and it's slow and big." in: query required: false schema: type: string enum: - UNKNOWN_INQUIRY_OPTION - INQUIRY_ENTITY - INQUIRY_OVERVIEW - INQUIRY_ALL default: UNKNOWN_INQUIRY_OPTION tags: - AdGroup post: summary: Create a new AdGroup. description: Create a new AdGroup of the Campaign. operationId: DspApi_CreateAdGroup responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesCreateAdGroupResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesCreateAdGroupError' parameters: - name: campaign_id description: The Campaign ID the AdGroup belongs to. in: query required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/dspAdGroup' description: The AdGroup date to be created. required: true tags: - AdGroup /cm/v1/ad-groups/{ad_group_id}: get: summary: Read an existing AdGroup. description: Read an existing AdGroup. operationId: DspApi_ReadAdGroup responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesReadAdGroupResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesReadAdGroupError' parameters: - name: ad_group_id description: The ID of the AdGroup to be retrieved. in: path required: true schema: type: string - name: campaign_id description: The Campaign ID the AdGroup belongs to. in: query required: true schema: type: string tags: - AdGroup delete: summary: Delete an existing AdGroup. description: Delete an existing AdGroup. operationId: DspApi_DeleteAdGroup responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesDeleteAdGroupResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesDeleteAdGroupError' parameters: - name: ad_group_id description: The ID of the AdGroup to be deleted. in: path required: true schema: type: string - name: campaign_id description: The Campaign ID the AdGroup belongs to. in: query required: true schema: type: string tags: - AdGroup put: summary: Update an existing AdGroup. description: Update an existing AdGroup. operationId: DspApi_UpdateAdGroup responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesUpdateAdGroupResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesUpdateAdGroupError' parameters: - name: ad_group_id description: The ID of the AdGroup to be updated. in: path required: true schema: type: string - name: campaign_id description: The Campaign ID the AdGroup belongs to. in: query required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/dspAdGroup' description: The AdGroup data to be updated. required: true tags: - AdGroup /cm/v1/analytics-detail: post: summary: Provide the detail of ad performance analytics. description: Provide the detail of ad performance analytics. operationId: DspApi_QueryAnalyticsDetail responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesQueryAnalyticsDetailResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' requestBody: content: application/json: schema: $ref: '#/components/schemas/messagesQueryAnalyticsDetailRequest' required: true tags: - Analytics /cm/v1/analytics-overview: post: summary: Provide the overview of ad performance analytics. description: Provide the overview of ad performance analytics. operationId: DspApi_QueryAnalyticsOverview responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesQueryAnalyticsOverviewResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' requestBody: content: application/json: schema: $ref: '#/components/schemas/messagesQueryAnalyticsOverviewRequest' required: true tags: - Analytics /cm/v1/analytics-skadnetwork: post: summary: Provide the SKAdNetwork ad performance analytics. description: Provide the SKAdNetwork ad performance analytics. operationId: DspApi_QueryAnalyticsSKAdNetwork responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesQueryAnalyticsSKAdNetworkResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' requestBody: content: application/json: schema: $ref: '#/components/schemas/messagesQueryAnalyticsSKAdNetworkRequest' required: true tags: - Analytics /cm/v1/audience-targets: get: summary: List up AudienceTargets. description: List up all AudienceTargets of the AdAccount. operationId: DspApi_ListAudienceTargets responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesListAudienceTargetsResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesListAudienceTargetsError' parameters: - name: ad_account_id description: The AdAccount ID the AudienceTargets belong to. in: query required: true schema: type: string tags: - AudienceTarget post: summary: Create a new AudienceTarget. description: Create a new AudienceTarget of the AdAccount. operationId: DspApi_CreateAudienceTarget responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesCreateAudienceTargetResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesCreateAudienceTargetError' parameters: - name: ad_account_id description: The AdAccount ID the AudienceTarget belongs to. in: query required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/dspSharedAudienceTarget' description: The AudienceTarget data to be created. required: true tags: - AudienceTarget /cm/v1/audience-targets/{audience_target_id}: get: summary: Read an existing AudienceTarget. description: Read an existing AudienceTarget. operationId: DspApi_ReadAudienceTarget responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesReadAudienceTargetResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesReadAudienceTargetError' parameters: - name: audience_target_id description: The ID of the AudienceTarget to be retrieved. in: path required: true schema: type: string - name: ad_account_id description: The AdAccount ID the AudienceTarget belongs to. in: query required: true schema: type: string tags: - AudienceTarget delete: summary: Delete an existing AudienceTarget. description: Delete an existing AudienceTarget. operationId: DspApi_DeleteAudienceTarget responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesDeleteAudienceTargetResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesDeleteAudienceTargetError' parameters: - name: audience_target_id description: The ID of the AudienceTarget to be deleted. in: path required: true schema: type: string - name: ad_account_id description: The AdAccount ID the AudienceTarget belongs to. in: query required: true schema: type: string tags: - AudienceTarget put: summary: Update an existing AudienceTarget. description: Update an existing AudienceTarget. operationId: DspApi_UpdateAudienceTarget responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesUpdateAudienceTargetResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesUpdateAudienceTargetError' parameters: - name: audience_target_id description: The ID of the AudienceTarget to be updated. in: path required: true schema: type: string - name: ad_account_id description: The AdAccount ID the AudienceTarget belongs to. in: query required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/dspSharedAudienceTarget' description: The AudienceTarget data to be updated. required: true tags: - AudienceTarget /cm/v1/auth/ad-account/{ad_account_id}/users: get: summary: List ad account users description: 'List users under a certain ad account. With `include_role` query parameter, response can include roles. API callers who have a WORKPLACE_OWNER or AD_ACCOUNT_OWNER or AD_ACCOUNT_MEMBER role can call this API.' operationId: DspApi_ListAdAccountUsers responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesListAdAccountUsersResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: ad_account_id description: The ad account ID. in: path required: true schema: type: string - name: include_role description: Flag whether response includes user's role. in: query required: false schema: type: boolean tags: - User /cm/v1/auth/password: post: summary: Update user password description: 'Update user password. You can call this API with token whose type is AUTH_TOKEN, UPDATE_PASSWORD_TOKEN.' operationId: DspApi_UpdatePassword responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesUpdatePasswordResponse' default: description: 'Error. Detailed cause can be found in the `details` field. ' content: application/json: schema: $ref: '#/components/schemas/messagesUpdatePasswordError' requestBody: content: application/json: schema: $ref: '#/components/schemas/messagesUpdatePasswordRequest' required: true tags: - User /cm/v1/auth/roles/grant: post: summary: Grant the role to the user description: Grant the Role to the user. operationId: DspApi_GrantRole responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesGrantRoleResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesGrantRoleError' requestBody: content: application/json: schema: $ref: '#/components/schemas/messagesGrantRoleRequest' required: true tags: - Role /cm/v1/auth/roles/revoke: post: summary: Revoke the role from the user description: Revoke the role from the user operationId: DspApi_RevokeRole responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesRevokeRoleResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesRevokeRoleError' requestBody: content: application/json: schema: $ref: '#/components/schemas/messagesRevokeRoleRequest' required: true tags: - Role /cm/v1/auth/tokens: post: summary: Issue a new token. description: 'Issues a new token that gives you access to Moloco Ads APIs. Tokens are issued by workplace such that you need a unique token for each workplace you would like access to. Each token is valid for 16 hours, and you will need a new token after the token has expired.' operationId: DspApi_CreateToken responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesCreateTokenResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesCreateTokenError' requestBody: content: application/json: schema: $ref: '#/components/schemas/messagesCreateTokenRequest' required: true tags: - Token security: [] /cm/v1/auth/users: get: summary: List workplace users description: 'List users under a certain workplace. With `include_role` query parameter, response can include roles. Only API callers who have a WORKPLACE_OWNER role can call this API.' operationId: DspApi_ListWorkplaceUsers responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesListWorkplaceUsersResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: include_role description: Flag whether response includes user's role. in: query required: false schema: type: boolean - name: filter_roles description: "Filter the users who have this role.\nIf multiple roles are given, users who have one of these roles\ \ are filtered.\n\n - WORKPLACE_OWNER: Workplace owner represents a user who can do anything in a given workplace.\n\ \ - AD_ACCOUNT_OWNER: Ad account owner represents a user who can do anything in a given ad account.\n - AD_ACCOUNT_MEMBER:\ \ Ad account member can view all users of the Ad Account.\nCan invite new users as Ad Account Member or Ad Account\ \ Viewer\nCan edit your own information (ex: name)\nCan create and edit ad campaigns\n - AD_ACCOUNT_VIEWER: Ad account\ \ Viewer role offers a limited set of permissions that allows users\nonly to read the basic information of the resources." in: query required: false explode: true schema: type: array items: type: string enum: - WORKPLACE_OWNER - AD_ACCOUNT_OWNER - AD_ACCOUNT_MEMBER - AD_ACCOUNT_VIEWER - name: match_roles description: "Select the users who have this role.\nIf multiple roles are given, only users who have all of these\ \ roles are selected.\n\n - WORKPLACE_OWNER: Workplace owner represents a user who can do anything in a given workplace.\n\ \ - AD_ACCOUNT_OWNER: Ad account owner represents a user who can do anything in a given ad account.\n - AD_ACCOUNT_MEMBER:\ \ Ad account member can view all users of the Ad Account.\nCan invite new users as Ad Account Member or Ad Account\ \ Viewer\nCan edit your own information (ex: name)\nCan create and edit ad campaigns\n - AD_ACCOUNT_VIEWER: Ad account\ \ Viewer role offers a limited set of permissions that allows users\nonly to read the basic information of the resources." in: query required: false explode: true schema: type: array items: type: string enum: - WORKPLACE_OWNER - AD_ACCOUNT_OWNER - AD_ACCOUNT_MEMBER - AD_ACCOUNT_VIEWER tags: - User /cm/v1/auth/users/complete-signup: post: summary: Complete user signup description: 'Complete the user signup with additional info. The bearer token should be the password reset token which is achieved from `create password email`. Once this API succeeds, the user’s signed_up status becomes true.' operationId: DspApi_CompleteSignup responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesCompleteSignupResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesCompleteSignupError' requestBody: content: application/json: schema: $ref: '#/components/schemas/messagesCompleteSignupRequest' required: true tags: - User /cm/v1/auth/users/expel: post: summary: Expel the user description: 'Expel the user from an API callers’ workplace. Only API callers who have the WORKPLACE_OWNER role can expel users. Expelled users will no longer have any roles under the workplace.' operationId: DspApi_ExpelUser responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesExpelUserResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesExpelUserError' requestBody: content: application/json: schema: $ref: '#/components/schemas/messagesExpelUserRequest' required: true tags: - User /cm/v1/auth/users/forgot-password: post: summary: Forgot user password description: 'If the user forgot the password, use this API to receive `password reset email`. The `password reset email` contains password reset token for updating password and user’s email which will be used to call `UpdatePassword` API. The token is valid for 7 days.' operationId: DspApi_ForgotPassword responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesForgotPasswordResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' requestBody: content: application/json: schema: $ref: '#/components/schemas/messagesForgotPasswordRequest' required: true tags: - User security: [] /cm/v1/auth/users/invite: post: summary: Invite the user description: 'Invite the user to an API callers’ workplace. The user who has WORKPLACE_OWNER or AD_ACCOUNT_OWNER or AD_ACCOUNT_MEMBER Roles can invite users to a workplace.' operationId: DspApi_InviteUser responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesInviteUserResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesInviteUserError' requestBody: content: application/json: schema: $ref: '#/components/schemas/messagesInviteUserRequest' required: true tags: - User /cm/v1/auth/users/reset-password: post: summary: Reset the user password description: 'reset the user password. The bearer token should be the password reset token which is achieved from `password reset email`. Once this API succeeds, the user’s signed_up status becomes true.' operationId: DspApi_ResetPassword responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesResetPasswordResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesResetPasswordError' requestBody: content: application/json: schema: $ref: '#/components/schemas/messagesResetPasswordRequest' required: true tags: - User /cm/v1/auth/users/withdrawal: post: summary: Delete the user description: 'Delete the user. ' operationId: DspApi_DeleteUser responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesDeleteUserResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesDeleteUserError' requestBody: content: application/json: schema: $ref: '#/components/schemas/messagesDeleteUserRequest' required: true tags: - User security: [] /cm/v1/auth/users/{user_id}: get: summary: Read the user description: 'Read the user under API caller''s workplace. If include_role specified, response will include roles bound to API caller''s workplace and ad account (if exists). The user who has any role except AD_ACCOUNT_VIEWER can call this API. A user who has an AD_ACCOUNT_VIEWER role can only read itself.' operationId: DspApi_ReadUser responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesReadUserResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesReadUserError' parameters: - name: user_id description: The user ID. in: path required: true schema: type: string - name: include_role description: Flag whether response includes user's role. in: query required: false schema: type: boolean tags: - User put: summary: Update the user description: Update the user's info such as name. operationId: DspApi_UpdateUser responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesUpdateUserResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesUpdateUserError' parameters: - name: user_id description: The user ID. in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: user: $ref: '#/components/schemas/dspUser' description: The user. required: - user required: true tags: - User /cm/v1/auth/workplaces: get: summary: List API caller's registered workplaces description: List workplaces to which the user has registered. operationId: DspApi_ListWorkplaces responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesListWorkplacesResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: show_history description: 'Flag to include creation request histories. If true, the response will include Workplace creation request histories. If false, the response will not include Workplace creation request histories.' in: query required: false schema: type: boolean tags: - User /cm/v1/auth/workplaces-by-domain: get: summary: List workplaces by domain with invitation status description: List workplaces by domain with the info whether API caller requested an invitation to this workplace or not. operationId: DspApi_ListWorkplacesByDomain responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesListWorkplacesByDomainResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' tags: - User /cm/v1/auth/workplaces/{workplace_id}: get: summary: Read the workplace description: Read the workplace. The workplace is an API caller's signed workplace. All roles can call this API. operationId: DspApi_ReadWorkplace responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesReadWorkplaceResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: workplace_id description: The ID of the workplace. in: path required: true schema: type: string tags: - Workplace /cm/v1/campaign-overviews: get: summary: Query given Campaigns' setting overview description: Retrieve not only Campaign itself but all the entities related to the Campaign operationId: DspApi_QueryCampaignOverviews responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesQueryCampaignOverviewsResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: ad_account_id description: The AdAccount ID which the Campaigns belong to. in: query required: true schema: type: string - name: product_id description: The Product ID which the Campaigns belongs to. in: query required: true schema: type: string - name: campaign_ids description: The list of Campaign IDs to query for the overview data. in: query required: true explode: true schema: type: array items: type: string tags: - Campaign /cm/v1/campaigns: get: summary: List up Campaigns. description: List up all Campaigns of the AdAccount or the Product. operationId: DspApi_ListCampaigns responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesListCampaignsResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesListCampaignsError' parameters: - name: ad_account_id description: The AdAccount ID to which the Campaigns belong to. in: query required: true schema: type: string - name: product_id description: The Product ID to which the Campaigns belong to. in: query required: false schema: type: string - name: states description: "The states of the Campaigns to be listed.\nDeleted Campaigns can not be listed with this parameter.\n\ \n - SUBMITTED: All the required data are entered and passed all the validation. It's eligible\nto be reviewed by\ \ Moloco for activation.\n - READY: Campaign is before schedule and internally ready but disabled.\nWill transit\ \ to PAUSED when it becomes on schdule.\n - UPCOMING: Campaign is before schedule and internally ready and disabled.\n\ Will transit to ACTIVE when it becomes on schdule.\n - ACTIVE: Campaign is on schedule and spending the budget.\n\ \ - PAUSED: Campaign is paused and not spending the budget.\n - SUSPENDED: Campaign activation is suspended by the\ \ system for the following reasons:\n- App has been found to be in violation of Moloco's creative policy.\n - COMPLETED:\ \ Campaign is completed but may still get attributions for some time." in: query required: false explode: true schema: type: array items: type: string enum: - UNKNOWN_CAMPAIGN_STATE - SUBMITTED - READY - UPCOMING - ACTIVE - PAUSED - SUSPENDED - COMPLETED - name: fetch_option description: "Fetch option to query Campaigns only deleted or all(deleted & not deleted).\nIf fetch_option is not\ \ specified, it will fetch only alive Campaigns.\n\n - FETCH_ALL: Fetch all Campaigns including deleted and not\ \ deleted.\n - FETCH_ONLY_DELETED: Fetch only deleted Campaigns." in: query required: false schema: type: string enum: - UNKNOWN_FETCH_OPTION - FETCH_ALL - FETCH_ONLY_DELETED default: UNKNOWN_FETCH_OPTION tags: - Campaign post: summary: Create a new Campaign. description: Create a new Campaign. operationId: DspApi_CreateCampaign responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesCreateCampaignResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesCreateCampaignError' parameters: - name: ad_account_id description: The AdAccount ID which the Campaign belongs to. in: query required: true schema: type: string - name: product_id description: The Product ID which the Campaign belongs to. in: query required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/messagesCampaignInput' description: The Campaign to create and its initial PayoutItem and AdGroup information. required: true tags: - Campaign /cm/v1/campaigns/{campaign_id}: get: summary: Read an existing Campaign. description: Read an existing Campaign. operationId: DspApi_ReadCampaign responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesReadCampaignResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesReadCampaignError' parameters: - name: campaign_id description: The ID of the Campaign to be retrieved. in: path required: true schema: type: string tags: - Campaign delete: summary: Delete an existing Campaign. description: Delete an existing Campaign. Only Campaigns that have never been activated can be deleted. operationId: DspApi_DeleteCampaign responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesDeleteCampaignResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesDeleteCampaignError' parameters: - name: campaign_id description: The ID of the Campaign to be deleted. in: path required: true schema: type: string tags: - Campaign put: summary: Update an existing Campaign. description: Update an existing Campaign. operationId: DspApi_UpdateCampaign responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesUpdateCampaignResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesUpdateCampaignError' parameters: - name: campaign_id description: The ID of the Campaign to be updated. in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/dspCampaign' description: The Campaign to update. required: true tags: - Campaign /cm/v1/cohort-summary: get: summary: Read a cohort summary. description: Read a cohort summary. operationId: DspApi_ReadCohortSummary responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesReadCohortSummaryResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesReadCohortSummaryError' parameters: - name: ad_account_id description: The AdAccount ID to which a cohort summary belongs to. in: query required: true schema: type: string - name: date_range.start description: Start date in the format of YYYY-MM-DD (inclusive). in: query required: true schema: type: string - name: date_range.end description: 'End date in the format of YYYY-MM-DD (inclusive). Max 31 days from the start date.' in: query required: true schema: type: string - name: type description: "Cohort metric type. If not specified, ROAS is selected.\n\n - ROAS: Deprecated.\n - KPI_ACTION: Deprecated.\n\ \ - UA_ROAS: Cohort ROAS metric type for user acquisition Campaigns.\n - UA_KPI_ACTION: Cohort KPI actions metric\ \ type for user acquisition Campaigns.\n - RE_ROAS: Cohort ROAS metric type for re-engagement Campaigns.\n - RE_KPI_ACTION:\ \ Cohort KPI actions metric type for re-engagement Campaigns." in: query required: false schema: type: string enum: - UNKNOWN - ROAS - KPI_ACTION - UA_ROAS - UA_KPI_ACTION - RE_ROAS - RE_KPI_ACTION default: UNKNOWN - name: actions description: 'Actions to be included in a cohort summary, which are revenue actions for ROAS or KPI actions for KPI_ACTION. If not specified, all the actions are included.' in: query required: false explode: true schema: type: array items: type: string tags: - CohortSummary /cm/v1/creative-assets: post: summary: Create a new asset upload session. description: 'Create a new asset upload session for the AdAccount. A URL would be returned in a successful response for uploading the actual asset content. After asset upload has been successfully completed, see [the campaign creation guide](https://developer.moloco.cloud/docs/campaign-management-api) and follow [Section 4-1 for those using Moloco Ads API v1.7 or later](https://developer.moloco.cloud/docs/campaign-management-api#4-1-upload-a-creative-asset-to-storage-for-those-using-moloco-ads-api-v17-or-later)' operationId: DspApi_CreateAssetUploadSession responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesCreateAssetUploadSessionResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesCreateAssetUploadSessionError' parameters: - name: ad_account_id description: The AdAccount ID. in: query required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAssetUploadSessionRequestAssetUploadSessionInfo' description: The information to upload the asset. required: true tags: - Creative /cm/v1/creative-groups: get: summary: List up CreativeGroups. description: List up all CreativeGroups of the AdAccount or the Product. operationId: DspApi_ListCreativeGroups responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesListCreativeGroupsResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesListCreativeGroupsError' parameters: - name: ad_account_id description: The AdAccount ID of the listing CreativeGroups belong to. in: query required: true schema: type: string - name: product_id description: The Product ID to which the CreativeGroups belong. in: query required: false schema: type: string - name: inquiry_option description: "InquiryOption to specify which information to retrieve.\n\n - INQUIRY_ENTITY: Only the target entity\ \ itself is returned in response.\nThis InquiryOption is faster than other options as it reads the single entity\ \ from the database.\n - INQUIRY_OVERVIEW: The target entity's overview information is returned in response.\nIn\ \ general, the overview information includes the brief content of the target entity and its related entities.\n\ This InquiryOption is slower than INQUIRY_ENTITY but the returned data size is usually smaller than that.\n - INQUIRY_ALL:\ \ The target entity and its summary information is returned in response.\nThis InquiryOption is equivalent to INQUIRY_ENTITY\ \ + INQUIRY_OVERVIEW, and it's slow and big." in: query required: false schema: type: string enum: - UNKNOWN_INQUIRY_OPTION - INQUIRY_ENTITY - INQUIRY_OVERVIEW - INQUIRY_ALL default: UNKNOWN_INQUIRY_OPTION tags: - CreativeGroup delete: summary: Delete existing CreativeGroups. description: Delete existing CreativeGroups. operationId: DspApi_DeleteCreativeGroupsBulk responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesDeleteCreativeGroupsBulkResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: ad_account_id description: The AdAccount ID of the CreativeGroups to be deleted. in: query required: true schema: type: string - name: creative_group_ids description: The ID of the CreativeGroups to be deleted. in: query required: true explode: true schema: type: array items: type: string tags: - CreativeGroup post: summary: Create a new CreativeGroup. description: Create a new CreativeGroup of the Product. operationId: DspApi_CreateCreativeGroup responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesCreateCreativeGroupResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesCreateCreativeGroupError' parameters: - name: ad_account_id description: The AdAccount ID to which the CreativeGroup belongs to. in: query required: true schema: type: string - name: product_id description: The Product ID to which the CreativeGroup belongs to. in: query required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/dspCreativeGroup' description: The CreativeGroup data to be created. required: true tags: - CreativeGroup /cm/v1/creative-groups/sync-clones: post: summary: Copy CreativeGroups synchronously. description: Copy selected CreativeGroups from one Product to another(or the same) Product within an AdAccount synchronously. operationId: DspApi_CopyCreativeGroupsSync responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesCopyCreativeGroupsSyncResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' requestBody: content: application/json: schema: $ref: '#/components/schemas/messagesCopyCreativeGroupsSyncRequest' required: true tags: - CreativeGroup /cm/v1/creative-groups/{creative_group_id}: get: summary: Read an existing CreativeGroup. description: Read an existing CreativeGroup. operationId: DspApi_ReadCreativeGroup responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesReadCreativeGroupResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesReadCreativeGroupError' parameters: - name: creative_group_id description: The ID of the CreativeGroup to be retrieved. in: path required: true schema: type: string - name: inquiry_option description: "InquiryOption to specify which information to retrieve.\n\n - INQUIRY_ENTITY: Only the target entity\ \ itself is returned in response.\nThis InquiryOption is faster than other options as it reads the single entity\ \ from the database.\n - INQUIRY_OVERVIEW: The target entity's overview information is returned in response.\nIn\ \ general, the overview information includes the brief content of the target entity and its related entities.\n\ This InquiryOption is slower than INQUIRY_ENTITY but the returned data size is usually smaller than that.\n - INQUIRY_ALL:\ \ The target entity and its summary information is returned in response.\nThis InquiryOption is equivalent to INQUIRY_ENTITY\ \ + INQUIRY_OVERVIEW, and it's slow and big." in: query required: false schema: type: string enum: - UNKNOWN_INQUIRY_OPTION - INQUIRY_ENTITY - INQUIRY_OVERVIEW - INQUIRY_ALL default: UNKNOWN_INQUIRY_OPTION tags: - CreativeGroup delete: summary: Delete an existing CreativeGroup. description: Delete an existing CreativeGroup. operationId: DspApi_DeleteCreativeGroup responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesDeleteCreativeGroupResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesDeleteCreativeGroupError' parameters: - name: creative_group_id description: The ID of the CreativeGroup to be deleted. in: path required: true schema: type: string tags: - CreativeGroup put: summary: Update an existing CreativeGroup. description: Update an existing CreativeGroup. operationId: DspApi_UpdateCreativeGroup responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesUpdateCreativeGroupResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesUpdateCreativeGroupError' parameters: - name: creative_group_id description: The ID of the CreativeGroup to be updated. in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/dspCreativeGroup' description: The CreativeGroup data to be updated. required: true tags: - CreativeGroup /cm/v1/creative-reviews: get: summary: List CreativeReviews. description: List the creative reviews of an AdAccount. Only creatives with UNDER_REVIEW, BLOCKED, or ETC status are returned. Id is provided through the query param ad_account_id. operationId: DspApi_ListCreativeReviews responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesListCreativeReviewsResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesListCreativeReviewsError' parameters: - name: ad_account_id in: query required: false schema: type: string - name: review_states description: "The CreativeReview status to retrieve.\nRetrieves all status as a default (If it is empty).\nIt should\ \ be given by query params in the REST API. (e.g. ?review_states=UNDER_REVIEW&review_states=APPROVED).\n\n - UNDER_REVIEW:\ \ Creative is currently under review.\n - APPROVED: Creative has been accepted by the exchange.\n - BLOCKED: Creative\ \ has been rejected by the exchange.\n - ETC: Refer to ReviewAction for more details.\n - APPROVED_FOR_ADULTS: Creative\ \ has been accepted only for adults by the exchange.\n - GOOGLE_PLATFORM_APPROVED: Creative is rejected by ADX (and\ \ ADX_RTB) on network policy but approved on platform policy.\nIn ADX requests, a flag will indicate whether a creative\ \ with this status can bid.\nThis status will only be used in ADX reviews." in: query required: false explode: true schema: type: array items: type: string enum: - UNKNOWN - UNDER_REVIEW - APPROVED - BLOCKED - ETC - APPROVED_FOR_ADULTS - GOOGLE_PLATFORM_APPROVED - name: campaign_states description: "The Campaign status of the list of CreativeGroups used by.\nRetrieves all status as a default (If it\ \ is empty).\nIt should be given by query params in the REST API. (e.g. ?campaign_states=DRAFT&campaign_states=SUBMITTED).\n\ \n - SUBMITTED: All the required data are entered and passed all the validation. It's eligible\nto be reviewed by\ \ Moloco for activation.\n - READY: Campaign is before schedule and internally ready but disabled.\nWill transit\ \ to PAUSED when it becomes on schdule.\n - UPCOMING: Campaign is before schedule and internally ready and disabled.\n\ Will transit to ACTIVE when it becomes on schdule.\n - ACTIVE: Campaign is on schedule and spending the budget.\n\ \ - PAUSED: Campaign is paused and not spending the budget.\n - SUSPENDED: Campaign activation is suspended by the\ \ system for the following reasons:\n- App has been found to be in violation of Moloco's creative policy.\n - COMPLETED:\ \ Campaign is completed but may still get attributions for some time." in: query required: false explode: true schema: type: array items: type: string enum: - UNKNOWN_CAMPAIGN_STATE - SUBMITTED - READY - UPCOMING - ACTIVE - PAUSED - SUSPENDED - COMPLETED tags: - Creative /cm/v1/creatives: get: summary: List up Creatives. description: List up all creatives of the AdAccount or the Product. operationId: DspApi_ListCreatives responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesListCreativesResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesListCreativesError' parameters: - name: ad_account_id description: The AdAccount ID to which the Creatives belong to. in: query required: true schema: type: string - name: product_id description: The Product ID to which the Creatives belong to. in: query required: false schema: type: string - name: types description: "The type of the Creatives to be listed.\nIf not specified, all types of Creatives will be listed.\n\n\ \ - UNKNOWN_TYPE: This value is not part of the specification.\n - IMAGE: Image Creative. The image Creative source\ \ must be specified for this type.\n - VIDEO: Video Creative. The video Creative source must be specified for this\ \ type.\n - VAST_VIDEO: Vast video Creative. The vast video Creative source must be specified for this type.\n -\ \ NATIVE: Deprecated. v1.5 is the last version supporting this version.\nNative Creative. The native Creative source\ \ must be specified for this type.\n - NATIVE_IMAGE: Native image Creative. The native image Creative source must\ \ be specified for this type.\n - NATIVE_VIDEO: Native video Creative. The native video Creative source must be\ \ specified for this type.\n - CUSTOM_HTML: (Will be supported soon) Custom HTML Creative. The custom HTML Creative\ \ source must be specified for this type.\n - TEMPLATE_HTML: (Will be supported soon) Template HTML Creative. The\ \ template HTML Creative source must be specified for this type.\n - RICH_CUSTOM_HTML: The rich custom HTML Creative.\ \ The rich custom HTML Creative source must be specified for this type.\n - DYNAMIC_HTML: (Will be supported soon)\ \ The dynamic HTML Creative. The dynamic HTML Creative source must be specified for this type.\n - AD_TAG: (Will\ \ be supported soon) Third-party ad tag Creative with script-based or vast tag-based ad tag." in: query required: false explode: true schema: type: array items: type: string enum: - UNKNOWN_TYPE - IMAGE - VIDEO - VAST_VIDEO - NATIVE - NATIVE_IMAGE - NATIVE_VIDEO - CUSTOM_HTML - TEMPLATE_HTML - RICH_CUSTOM_HTML - DYNAMIC_HTML - AD_TAG - name: order_by.key in: query required: false schema: type: string enum: - UNKNOWN_ORDER_BY - UPDATED_AT default: UNKNOWN_ORDER_BY - name: order_by.is_descending in: query required: false schema: type: boolean - name: inquiry_option description: "InquiryOption to specify which information to retrieve.\n\n - INQUIRY_ENTITY: Only the target entity\ \ itself is returned in response.\nThis InquiryOption is faster than other options as it reads the single entity\ \ from the database.\n - INQUIRY_OVERVIEW: The target entity's overview information is returned in response.\nIn\ \ general, the overview information includes the brief content of the target entity and its related entities.\n\ This InquiryOption is slower than INQUIRY_ENTITY but the returned data size is usually smaller than that.\n - INQUIRY_ALL:\ \ The target entity and its summary information is returned in response.\nThis InquiryOption is equivalent to INQUIRY_ENTITY\ \ + INQUIRY_OVERVIEW, and it's slow and big." in: query required: false schema: type: string enum: - UNKNOWN_INQUIRY_OPTION - INQUIRY_ENTITY - INQUIRY_OVERVIEW - INQUIRY_ALL default: UNKNOWN_INQUIRY_OPTION tags: - Creative delete: summary: Delete existing Creatives. description: Delete existing creatives. operationId: DspApi_DeleteCreativesBulk responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesDeleteCreativesBulkResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesDeleteCreativesBulkError' parameters: - name: ad_account_id description: The AdAccount ID. in: query required: true schema: type: string - name: creative_ids description: The ID of the Creatives to be deleted. in: query required: true explode: true schema: type: array items: type: string tags: - Creative post: summary: Create a new Creative. description: 'Create a new creative of the product. One and only one of the sources must be specified for the Creative.' operationId: DspApi_CreateCreative responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesCreateCreativeResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesCreateCreativeError' parameters: - name: ad_account_id description: The AdAccount ID which the Creative belongs to. in: query required: true schema: type: string - name: product_id description: The Product ID which the Creative belongs to. in: query required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/dspCreative' description: The Creative to create. required: true tags: - Creative /cm/v1/creatives/sync-clones: post: summary: Copy Creatives synchronously. description: Copy selected Creatives from one Product to another(or the same)Product within an AdAccount synchronously operationId: DspApi_CopyCreativesSync responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesCopyCreativesSyncResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesCopyCreativesSyncError' requestBody: content: application/json: schema: $ref: '#/components/schemas/messagesCopyCreativesSyncRequest' required: true tags: - Creative /cm/v1/creatives/{creative_id}: get: summary: Read an existing Creative. description: Read an existing creative. operationId: DspApi_ReadCreative responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesReadCreativeResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesReadCreativeError' parameters: - name: creative_id description: The ID of the Creative to be retrieved. in: path required: true schema: type: string tags: - Creative delete: summary: Delete an existing Creative. description: Delete an existing creative. operationId: DspApi_DeleteCreative responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesDeleteCreativeResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesDeleteCreativeError' parameters: - name: creative_id description: The ID of the Creative to be deleted. in: path required: true schema: type: string tags: - Creative put: summary: Update an existing Creative. description: Update an existing creative. Only 'title', 'custom_key_values', 'enabling_state' could be updated. Exceptionally 'RICH_CUSTOM_HTML' could be updated. operationId: DspApi_UpdateCreative responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesUpdateCreativeResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesUpdateCreativeError' parameters: - name: creative_id description: The ID of the Creative to be updated. in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/dspCreative' description: 'If the Creative is currently in DRAFT state, the Mololo AdCloud won''t mandate it to have all required data on updates. However, any entered data should still pass their individual validation. The client can switch the Creative from DRAFT to SUBMITTED by specifying SUBMITTED as the new state value, in which case full validation will be invoked and all required data must have been entered. No other state values other than DRAFT and SUBMITTED are allowed when the Creative is in DRAFT state. Once the Creative gets out of the DRAFT state, the state value in the update requests will be ignored.' required: true tags: - Creative /cm/v1/customer-sets: get: summary: List up CustomerSets. description: List up all CustomerSets of the AdAccount. operationId: DspApi_ListCustomerSets responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesListCustomerSetsResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesListCustomerSetsError' parameters: - name: ad_account_id description: The AdAccount ID. in: query required: true schema: type: string tags: - CustomerSet post: summary: Create a new CustomerSet. description: Create a new CustomerSet. operationId: DspApi_CreateCustomerSet responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesCreateCustomerSetResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesCreateCustomerSetError' parameters: - name: ad_account_id description: The AdAccount ID. in: query required: true schema: type: string requestBody: $ref: '#/components/requestBodies/dspCustomerSet' tags: - CustomerSet /cm/v1/customer-sets/{customer_set_id}: get: summary: Read an existing CustomerSet. description: Read an existing CustomerSet. operationId: DspApi_ReadCustomerSet responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesReadCustomerSetResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesReadCustomerSetError' parameters: - name: customer_set_id description: The CustomerSet ID. in: path required: true schema: type: string tags: - CustomerSet delete: summary: Delete an existing CustomerSet. description: Delete an existing CustomerSet. operationId: DspApi_DeleteCustomerSet responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesDeleteCustomerSetResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesDeleteCustomerSetError' parameters: - name: customer_set_id description: The CustomerSet ID. in: path required: true schema: type: string tags: - CustomerSet put: summary: Update an existing CustomerSet. description: Update an existing CustomerSet. operationId: DspApi_UpdateCustomerSet responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesUpdateCustomerSetResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesUpdateCustomerSetError' parameters: - name: customer_set_id description: The CustomerSet ID. in: path required: true schema: type: string requestBody: $ref: '#/components/requestBodies/dspCustomerSet' tags: - CustomerSet /cm/v1/entity-counts: get: summary: Read entity counts description: 'Retrieve the current number of entities and the limits under each ancestor types. Visit the [guide document](https://developer.moloco.cloud/docs/entity-quota) for more details.' operationId: DspApi_ReadEntityCount responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesReadEntityCountResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: ad_account_id description: 'The AdAccount ID of the given entity type. Required for entity types: Product, Campaign, AdGroup, CreativeGroup, Creative, TrackingLink, Target, CustomterSet.' in: query required: false schema: type: string - name: product_id description: 'The Product ID of the given entity type. Required for entity types: Campaign, CreativeGroup, Creative.' in: query required: false schema: type: string - name: campaign_id description: 'The Campaign ID of the given entity type. Required for entity types: AdGroup.' in: query required: false schema: type: string - name: entity_type description: Entity type to query for. in: query required: true schema: type: string enum: - UNKNOWN_ENTITY_TYPE - ENTITY_TYPE_PLATFORM - ENTITY_TYPE_AD_ACCOUNT - ENTITY_TYPE_PRODUCT - ENTITY_TYPE_CAMPAIGN - ENTITY_TYPE_AD_GROUP - ENTITY_TYPE_CREATIVE_GROUP - ENTITY_TYPE_CREATIVE - ENTITY_TYPE_TRACKING_LINK - ENTITY_TYPE_TARGET - ENTITY_TYPE_CUSTOMER_SET - ENTITY_TYPE_CUSTOMER_ACTIVITY default: UNKNOWN_ENTITY_TYPE tags: - ReadEntityCount /cm/v1/logs: get: summary: List up logs. description: List up logs in the given Workplace. operationId: DspApi_ListLogs responses: '200': description: Successfully listed up the logs. content: application/json: schema: $ref: '#/components/schemas/messagesListLogsResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: ad_account_id description: ID of the AdAccount to list up logs. in: query required: true schema: type: string - name: date_range.start description: Start date in the format of YYYY-MM-DD (inclusive). in: query required: true schema: type: string - name: date_range.end description: End date in the format of YYYY-MM-DD (inclusive). Max 31 days from the start date. in: query required: true schema: type: string tags: - Log post: summary: Create a new log. description: Create a new log. operationId: DspApi_CreateLog responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesCreateLogResponse' '202': description: Accepted the log creation request. content: application/json: schema: $ref: '#/components/schemas/messagesCreateLogResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: ad_account_id description: Ad account ID to which a log associated. in: query required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/dspLog' description: The details of the new log specification. required: true tags: - Log /cm/v1/logs/{log_id}: get: summary: Read an existing log. description: Read an existing log. operationId: DspApi_ReadLog responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesReadLogResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: log_id description: Log ID to read. in: path required: true schema: type: string tags: - Log delete: summary: Delete an existing log. description: Delete an existing log. operationId: DspApi_DeleteLog responses: '200': description: Successfully deleted log. content: application/json: schema: $ref: '#/components/schemas/messagesDeleteLogResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: log_id description: Log ID to delete. in: path required: true schema: type: string tags: - Log /cm/v1/logs/{log_id}/status: get: summary: Read log status. description: Read the most recent log status. It will also show URLs containing log contents. operationId: DspApi_ReadLogStatus responses: '200': description: Successfully read log status. content: application/json: schema: $ref: '#/components/schemas/messagesReadLogStatusResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: log_id description: Log ID to read the status. in: path required: true schema: type: string tags: - Log /cm/v1/products: get: summary: List up Products. description: List all Products of the AdAccount. operationId: DspApi_ListProducts responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesListProductsResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesListProductsError' parameters: - name: ad_account_id description: The AdAccount ID to which the Product belongs. in: query required: true schema: type: string tags: - Product post: summary: Create a new Product. description: Create a new Product of the AdAccount. operationId: DspApi_CreateProduct responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesCreateProductResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesCreateProductError' parameters: - name: ad_account_id description: The AdAccount ID to which the Product belongs. in: query required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/dspProduct' description: The Product data to be created. required: true tags: - Product /cm/v1/products/{product_id}: get: summary: Read an existing Product. description: Read an existing Product. operationId: DspApi_ReadProduct responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesReadProductResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesReadProductError' parameters: - name: product_id description: The Product ID to be retrieved. in: path required: true schema: type: string tags: - Product delete: summary: Delete an existing Product. description: Delete an existing Product. operationId: DspApi_DeleteProduct responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesDeleteProductResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesDeleteProductError' parameters: - name: product_id description: The ID of the Product to delete. in: path required: true schema: type: string tags: - Product put: summary: Update an existing Product. description: Update an existing Product. operationId: DspApi_UpdateProduct responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesUpdateProductResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesUpdateProductError' parameters: - name: product_id description: The ID of the Product to be updated. in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/dspProduct' description: The Product data to be updated. required: true tags: - Product /cm/v1/products/{product_id}/app-event-summary: get: summary: Read an existing Product's app event summary. description: Read an existing Product's app event summary. operationId: DspApi_ReadProductAppEventSummary responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesReadProductAppEventSummaryResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesReadProductAppEventSummaryError' parameters: - name: product_id description: The Product ID to be retrieved. in: path required: true schema: type: string - name: condition.attribution in: query required: false schema: type: string enum: - UNKNOWN_ATTRIBUTION - ATTRIBUTION_ALL - ATTRIBUTED - UNATTRIBUTED default: UNKNOWN_ATTRIBUTION - name: condition.revenue in: query required: false schema: type: string enum: - UNKNOWN_REVENUE - REVENUE_ALL - REVENUE_TRUE - REVENUE_FALSE default: UNKNOWN_REVENUE - name: condition.time_window description: " - TIME_WINDOW_D30: Query with recent 30 days. (Default).\n - TIME_WINDOW_D90: Query with recent 90\ \ days.\n - TIME_WINDOW_TODAY: Query with today’s data." in: query required: false schema: type: string enum: - UNKNOWN_TIME_WINDOW - TIME_WINDOW_D30 - D30 - TIME_WINDOW_D90 - D90 - TIME_WINDOW_TODAY default: UNKNOWN_TIME_WINDOW tags: - Product /cm/v1/products/{product_id}/mmp-skan-conversion-config: get: summary: Read conversion value configuration from an integrated MMP. description: Read conversion value configuration stored in the MMP that is integrated with the Product using the tracking company and bundle ID data from its postback integration data. operationId: DspApi_ReadProductSKANConversionConfigFromMmp responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesReadProductSKANConversionConfigFromMmpResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesReadProductSKANConversionConfigFromMmpError' parameters: - name: product_id description: 'The ID of the Product to import SKAdNetwork conversion value configuration. The type of product OS should be IOS.' in: path required: true schema: type: string tags: - Product /cm/v1/products/{product_id}/skan-conversion-config: get: summary: Read conversion value configurations. description: Read conversion value configurations under an existing Product. operationId: DspApi_ReadProductSKANConversionConfig responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesReadProductSKANConversionConfigResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesReadProductSKANConversionConfigError' parameters: - name: product_id description: The ID of the Product related to the MMPI which will be updated. in: path required: true schema: type: string tags: - Product put: summary: Update conversion value configurations. description: Update conversion value configurations under an existing Product. operationId: DspApi_UpdateProductSKANConversionConfig responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesUpdateProductSKANConversionConfigResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesUpdateProductSKANConversionConfigError' parameters: - name: product_id description: The ID of the Product related to the MMPI which will be updated. in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MmpIntegrationConversionValueConfigurationItem' description: The SKAdNetwork conversion configuration data to be updated. required: true tags: - Product /cm/v1/report-action-events: get: summary: List up report action events. description: List up all available report action events for ad_account. operationId: DspApi_ListReportActionEvents responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesListReportActionEventsResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: ad_account_id description: The AdAccount ID of Campaigns to fetch the report actions. in: query required: true schema: type: string - name: include_moloco_pixel_events in: query required: false schema: type: boolean tags: - CampaignSummary /cm/v1/report-exports: get: summary: List up report exports. description: List up report exports in the given Workplace or AdAccount or Product. operationId: DspApi_ListReportExports responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesListReportExportsResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesListReportExportsError' parameters: - name: ad_account_id description: ID of the AdAccount to list up report exports. in: query required: false schema: type: string - name: product_id description: ID of the Product to list up report exports. in: query required: false schema: type: string tags: - ReportExport post: summary: Create a new report export. description: Create a new report export. operationId: DspApi_CreateReportExport responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesCreateReportExportResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesCreateReportExportError' parameters: - name: ad_account_id description: Ad account ID to which the report-export associated. in: query required: true schema: type: string - name: product_id description: Product ID to which the report-export associated. in: query required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/dspReportExport' description: The details of the new report export specification. required: true tags: - ReportExport /cm/v1/report-exports/{report_export_id}: get: summary: Read an existing report export. description: Read an existing report export. operationId: DspApi_ReadReportExport responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesReadReportExportResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesReadReportExportError' parameters: - name: report_export_id description: Report Export ID to read. in: path required: true schema: type: string tags: - ReportExport delete: summary: Delete an existing report export. description: Delete an existing report export. operationId: DspApi_DeleteReportExport responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesDeleteReportExportResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesDeleteReportExportError' parameters: - name: report_export_id description: Report Export ID to delete. in: path required: true schema: type: string tags: - ReportExport /cm/v1/report-filters: get: summary: List up report filter options. description: List up all available report filter options for ad_account. operationId: DspApi_ListReportFilters responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesListReportFiltersResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: ad_account_id description: The AdAccount ID of Campaigns to generate the report filter. in: query required: true schema: type: string tags: - CampaignSummary /cm/v1/reports: get: summary: List up reports. description: List up reports in the given Workplace and AdAccount. operationId: DspApi_ListReports responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesListReportsResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesListReportsError' parameters: - name: ad_account_id description: ID of the AdAccount to list up reports. in: query required: true schema: type: string tags: - Report post: summary: Create a new report. description: Create a new report of a specific AdAccount. operationId: DspApi_CreateReport responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesCreateReportResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesCreateReportError' parameters: - name: ad_account_id description: The AdAccount ID of Campaigns to create the reports. in: query required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/dspReport' description: The details of the new report specification. required: true tags: - Report /cm/v1/reports/{report_id}: get: summary: Read an existing report. description: Read an existing report. operationId: DspApi_ReadReport responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesReadReportResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesReadReportError' parameters: - name: report_id description: Report ID to read. in: path required: true schema: type: string tags: - Report delete: summary: Delete an existing report. description: Delete an existing report. operationId: DspApi_DeleteReport responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesDeleteReportResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesDeleteReportError' parameters: - name: report_id description: Report ID to delete. in: path required: true schema: type: string tags: - Report /cm/v1/reports/{report_id}/status: get: summary: Read report status. description: Read the most recent report status. It will also show URLs containing report contents. operationId: DspApi_ReadReportStatus responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesReadReportStatusResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesReadReportStatusError' parameters: - name: report_id description: Report ID to read the status. in: path required: true schema: type: string tags: - Report /cm/v1/tracking-links: get: summary: List up TrackingLinks. description: List up all TrackingLinks of the AdAccount or the Product. operationId: DspApi_ListTrackingLinks responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesListTrackingLinksResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesListTrackingLinksError' parameters: - name: ad_account_id description: The AdAccount ID which the TrackingLinks belong to. in: query required: true schema: type: string - name: product_id description: The Product ID which the TrackingLinks belong to. in: query required: false schema: type: string - name: inquiry_option description: "InquiryOption to specify which information to retrieve.\n\n - INQUIRY_ENTITY: Only the target entity\ \ itself is returned in response.\nThis InquiryOption is faster than other options as it reads the single entity\ \ from the database.\n - INQUIRY_OVERVIEW: The target entity's overview information is returned in response.\nIn\ \ general, the overview information includes the brief content of the target entity and its related entities.\n\ This InquiryOption is slower than INQUIRY_ENTITY but the returned data size is usually smaller than that.\n - INQUIRY_ALL:\ \ The target entity and its summary information is returned in response.\nThis InquiryOption is equivalent to INQUIRY_ENTITY\ \ + INQUIRY_OVERVIEW, and it's slow and big." in: query required: false schema: type: string enum: - UNKNOWN_INQUIRY_OPTION - INQUIRY_ENTITY - INQUIRY_OVERVIEW - INQUIRY_ALL default: UNKNOWN_INQUIRY_OPTION tags: - TrackingLink post: summary: Create a new TrackingLink. description: Create a new TrackingLink of the Product. operationId: DspApi_CreateTrackingLink responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesCreateTrackingLinkResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesCreateTrackingLinkError' parameters: - name: ad_account_id description: The AdAccount ID which the TrackingLink belongs to. in: query required: true schema: type: string - name: product_id description: The Product ID which the TrackingLink belongs to. in: query required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/dspTrackingLink' description: The TrackingLink data to be created. required: true tags: - TrackingLink /cm/v1/tracking-links/validate: post: summary: Validate a TrackingLink. description: Validate a TrackingLink of the product. operationId: DspApi_ValidateTrackingLink responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesValidateTrackingLinkResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesValidateTrackingLinkError' parameters: - name: ad_account_id description: The AdAccount ID. in: query required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/dspTrackingLink' description: 'The TrackingLink data to be validated. It should contain device_os, tracking_company and at least one link from click_through_link and view_through_link.' required: true tags: - TrackingLink /cm/v1/tracking-links/{tracking_link_id}: get: summary: Read an existing TrackingLink. description: Read an existing TrackingLink. operationId: DspApi_ReadTrackingLink responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesReadTrackingLinkResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesReadTrackingLinkError' parameters: - name: tracking_link_id description: The ID of the TrackingLink to be retrieved. in: path required: true schema: type: string - name: include_attempts description: Flag for whether include TrackingLink verification attempts. in: query required: false schema: type: boolean tags: - TrackingLink delete: summary: Delete an existing TrackingLink. description: Delete an existing TrackingLink. operationId: DspApi_DeleteTrackingLink responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesDeleteTrackingLinkResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesDeleteTrackingLinkError' parameters: - name: tracking_link_id description: The ID of the TrackingLink to be deleted. in: path required: true schema: type: string tags: - TrackingLink put: summary: Update an existing TrackingLink. description: Update an existing TrackingLink. operationId: DspApi_UpdateTrackingLink responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesUpdateTrackingLinkResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesUpdateTrackingLinkError' parameters: - name: tracking_link_id description: The ID of the TrackingLink to be updated. in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/dspTrackingLink' description: The updating TrackingLink data. required: true tags: - TrackingLink /cm/v1/workplace-summary: get: summary: Read a Workplace summary. description: Read a Workplace summary. operationId: DspApi_ReadWorkplaceSummary responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesReadWorkplaceSummaryError' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' parameters: - name: month_range.start description: Start month in the 'YYYY-MM' format. in: query required: true schema: type: string - name: month_range.end description: End month in the 'YYYY-MM' format. in: query required: true schema: type: string tags: - WorkplaceSummary security: - Bearer: [] servers: - url: https://api.moloco.cloud components: requestBodies: dspCustomerSet: content: application/json: schema: $ref: '#/components/schemas/dspCustomerSet' description: The CustomerSet data. required: true securitySchemes: Bearer: type: apiKey name: Authorization in: header schemas: AdAccountTargetFuturePreferenceInfo: type: object properties: product_scope: $ref: '#/components/schemas/TargetFuturePreferenceInfoProductScope' custom_products: $ref: '#/components/schemas/TargetFuturePreferenceInfoCustomProducts' description: 'TargetFuturePreferenceInfo contains each target''s future preference information. If the newly created Campaign satisfies the condition of target future preference info the target will be automatically assigned to that Campaign.' AnalyticsSKAdNetworkSKANConversionColumn: type: object properties: conversion_value: type: string description: SKAdNetwork fine-grained conversion value. ToString([0, 63]) or "NULL". version: type: string description: SKAdNetwork version. (e.g, 2.0, 2.1, 2.2). fidelity_type: type: string description: 'Raw SKAdNetwork fidelity type defined in Apple''s following document. https://developer.apple.com/documentation/storekit/skadnetwork/receiving_ad_attributions_and_postbacks As of June 2021, values are ToString([0, 1]) or "NULL".' conversion_count: type: string format: int64 description: 'The total number of SKAdNetwork conversions. It counts all SKAdNetwork conversions having did-win value as null for before version 3.0, and true for version 3.0 and later. See did-win flag in the [following document](https://developer.apple.com/documentation/storekit/skadnetwork/verifying_an_install-validation_postback?language=objc) for further details.' non_winning_conversion_count: type: string format: int64 description: 'The total number of non-winning SKAdNetwork conversions. It counts all SKAdNetwork conversions having did-win value as false for version 3.0 and later. See did-win flag in the [following document](https://developer.apple.com/documentation/storekit/skadnetwork/verifying_an_install-validation_postback?language=objc) for further details.' conversion_events: type: array items: type: object $ref: '#/components/schemas/AnalyticsSKAdNetworkSKANConversionEventColumn' description: SKAdNetwork Conversion Events associated with this specific conversion_value. description: SKANConversionColumn represents a structured column containing SKAdNetwork conversion value and its count for the current row. AnalyticsSKAdNetworkSKANConversionDimension: type: string enum: - UNKNOWN_SKAN_CONVERSION_DIMENSION - CONVERSION_VALUE - VERSION - FIDELITY_TYPE default: UNKNOWN_SKAN_CONVERSION_DIMENSION description: "SKANConversionDimension enumerates available SKAN conversion related dimensions.\n\n - UNKNOWN_SKAN_CONVERSION_DIMENSION:\ \ This value is not part of the API specification." AnalyticsSKAdNetworkSKANConversionEventColumn: type: object properties: name: type: string description: Conversion event name. count: type: string format: int64 description: The total number of conversions for a specific event. revenue_min_sum: type: number format: double description: The min sum value of revenue interval in conversion event. revenue_max_sum: type: number format: double description: The max sum value of revenue interval in conversion event. description: SKANConversionEventColumn represents a structured column containing the derived conversion event from SKAdNetwork conversion value. AppPropertiesAppEventType: type: string enum: - UNKNOWN - IN_APP_ADVERTISING - IN_APP_PURCHASE - SIGN_UP - SUBSCRIPTION - PREDICTED_LIFETIME_VALUE - ACHIEVE_LEVEL - START_TRIAL - ADD_PAYMENT_INFO - VIEW_PRODUCT_OR_CONTENT - ADD_TO_WISHLIST - SEARCH - ADD_TO_CART - BEGIN_CHECKOUT - FIRST_DEPOSIT - FIRST_TRADE - OTHER default: UNKNOWN description: AppEventType indicates standardized event types representing each in-app event. AppPropertiesAppScreenshots: type: object properties: urls: type: array items: type: string AppPropertiesIosPrimaryMeasurement: type: string enum: - IOS_PRIMARY_MEASUREMENT_UNKNOWN - IOS_PRIMARY_MEASUREMENT_NONE - IOS_PRIMARY_MEASUREMENT_SKAN - IOS_PRIMARY_MEASUREMENT_MMP default: IOS_PRIMARY_MEASUREMENT_UNKNOWN description: "Primary measurement used for iOS apps.\n\n - IOS_PRIMARY_MEASUREMENT_UNKNOWN: Zero value. Every non-iOS\ \ app must have this value.\n - IOS_PRIMARY_MEASUREMENT_NONE: Unset value for iOS app. It means the primary measurement\ \ is not decided yet.\n - IOS_PRIMARY_MEASUREMENT_SKAN: SKAdNetwork (SKAN)\n - IOS_PRIMARY_MEASUREMENT_MMP: MMP Probabilistic\ \ Attribution" AppPropertiesIosSecondaryMeasurement: type: string enum: - IOS_SECONDARY_MEASUREMENT_UNKNOWN - IOS_SECONDARY_MEASUREMENT_NONE - IOS_SECONDARY_MEASUREMENT_NA - IOS_SECONDARY_MEASUREMENT_SKAN - IOS_SECONDARY_MEASUREMENT_MMP - IOS_SECONDARY_MEASUREMENT_OTHER_MMP - IOS_SECONDARY_MEASUREMENT_OTHER_3P - IOS_SECONDARY_MEASUREMENT_INCREMENTALITY - IOS_SECONDARY_MEASUREMENT_CUSTOM default: IOS_SECONDARY_MEASUREMENT_UNKNOWN description: "Secondary measurement used for iOS apps.\n\n - IOS_SECONDARY_MEASUREMENT_UNKNOWN: Zero value. Every non-iOS\ \ app must have this value.\n - IOS_SECONDARY_MEASUREMENT_NONE: Unset value for iOS app. It means the secondary measurement\ \ is not decided yet.\n - IOS_SECONDARY_MEASUREMENT_NA: Not applicable. It means the iOS app does not use any secondary\ \ measurement.\n - IOS_SECONDARY_MEASUREMENT_SKAN: SKAdNetwork (SKAN). SKAN cannot be configured as both the primary\ \ and secondary measurement. If a secondary measurement is not required, use 'NA'.\n - IOS_SECONDARY_MEASUREMENT_MMP:\ \ MMP Probabilistic Attribution. MMP cannot be configured as both the primary and secondary measurement. If a secondary\ \ measurement is not required, use 'NA'.\n - IOS_SECONDARY_MEASUREMENT_OTHER_MMP: Other MMP measurements (e.g., unified\ \ iOS reporting, AppsFlyer SSOT, etc.)\n - IOS_SECONDARY_MEASUREMENT_OTHER_3P: Other 3P measurement tool (e.g., some\ \ customers are using other BI tools)\n - IOS_SECONDARY_MEASUREMENT_INCREMENTALITY: Incrementality measurement\n -\ \ IOS_SECONDARY_MEASUREMENT_CUSTOM: Custom measurement" AudienceTargetingConditionCoppaAcceptance: type: string enum: - UNKNOWN_COPPA - ACCEPT_COPPA_ONLY - DENY_COPPA default: UNKNOWN_COPPA description: "Indicates whether to bid according to the COPPA(Children's Online Privacy Protection Act)\nvalue of BidRequest.\n\ \n - UNKNOWN_COPPA: Doesn't filter BidRequest according to the coppa value.\n - ACCEPT_COPPA_ONLY: Bids to BidRequest\ \ with coppa=1.\n - DENY_COPPA: Bids to BidRequest with coppa=0 or empty coppa field." AudienceTargetingConditionCustomAudienceSet: type: object properties: include_having_all: $ref: '#/components/schemas/CustomAudienceSetCustomAudienceCondition' description: 'This will include a customer only if all of the listed conditions are satisfied. Note that it is not allowed to set include_having_all and include_having_any at the same time.' include_having_any: $ref: '#/components/schemas/CustomAudienceSetCustomAudienceCondition' description: This will include a customer if at least one condition from the listed conditions is satisfied. exclude_having_all: $ref: '#/components/schemas/CustomAudienceSetCustomAudienceCondition' description: 'This will exclude a customer only if all of the listed conditions are satisfied. Note that it is not allowed to set exclude_having_all and exclude_having_any at the same time.' exclude_having_any: $ref: '#/components/schemas/CustomAudienceSetCustomAudienceCondition' description: This will exclude a customer if at least one condition from the listed conditions is satisfied. description: 'CustomAudienceSet represents a group of target users to whom we''re going to show an ad. CustomAudienceSet is consist of a dynamic (not pre-determined) set of target users based on App-events described in the postback messages and pre-defined CustomerSets.' AudienceTargetingConditionDeviceOsFilter: type: object properties: os: $ref: '#/components/schemas/commonDeviceOs' description: Device OS. min_version: type: string max_version: type: string description: Device OS and version filter condition. required: - os AudienceTargetingConditionLocationFilter: type: object properties: cities: type: array items: type: string regions: type: array items: type: string zipcodes: type: array items: type: string geofences: type: array items: type: object $ref: '#/components/schemas/commonCircle' description: 'LocationFilter represents a geolocationcal condition using different related conditions. The condition will be met if any of the listed conditions is met.' AudienceTargetingConditionLocationSet: type: object properties: osm_ids: type: array items: type: string format: int64 description: OpenStreetMap IDs to represent areas to target. zipcodes: type: array items: type: object $ref: '#/components/schemas/LocationSetZipCodeSet' description: 'LocationSet represents target areas to allow or block. If multiple fields are set, a union of them is used.' AudienceTargetingConditionMediaChannelType: type: string enum: - UNKNOWN_MEDIA_CHANNEL_TYPE - APP - WEB default: UNKNOWN_MEDIA_CHANNEL_TYPE description: ' - UNKNOWN_MEDIA_CHANNEL_TYPE: This value is not part of the specification.' AudienceTargetingConditionNewUserFilter: type: object properties: last_n_days: type: integer format: int32 description: Target only new users with earliest known activities falling into the window of last N days. description: Filter to target new users only. required: - last_n_days AudienceTargetingConditionPlacementReason: type: string enum: - UNKNOWN_PLACEMENT_REASON - REASON_BRAND_SAFETY - REASON_PERFORMANCE_IMPROVEMENT - REASON_AGE_RESTRICTION - REASON_FRAUD - REASON_OWN_APP_CROSS_PROMOTION_BLOCKING - REASON_NOT_OPERATING_IN_A_SPECIFIC_LOCATION - REASON_INCREMENTALITY_TESTING - REASON_OTHER default: UNKNOWN_PLACEMENT_REASON description: The reason of the placement. It is used to track the reason why customers set the allowed or blocked app's. AudienceTargetingConditionRecentCampaignActivityFilter: type: object properties: event: $ref: '#/components/schemas/adcloudcommonEventType' description: Event type for the Campaign activities to filter on. campaign_id: type: string description: ID of the Campaign to filter on. last_n_days: type: integer format: int32 description: Target only new users with earliest known activities falling into the window of last N days. description: Recent Campaign activities for the targeted user. required: - event - campaign_id - last_n_days AudienceTargetingConditionSkanTraffic: type: string enum: - UNKNOWN_SKAN - TARGET_SKAN_ONLY - TARGET_NON_SKAN default: UNKNOWN_SKAN description: "Indicates whether to bid according to bid requests that support SKAN(SKAdNetwork) or not.\n\n - UNKNOWN_SKAN:\ \ Doesn't filter BidRequest according to support skan or not in this filter.\n - TARGET_SKAN_ONLY: Bids only for skan\ \ support traffic.\n - TARGET_NON_SKAN: Bids only for non-skan traffic." AudienceTargetingConditionWeeklyScheduleFilter: type: object properties: timezone_policy: $ref: '#/components/schemas/adcloudcommonTimezonePolicy' description: Timezone Policy to apply. hour_range: $ref: '#/components/schemas/adcloudcommonInterval' description: 'Hour range for each day specified below. It''s required and both start and end values must be in the range of [0, 23].' days: type: array items: $ref: '#/components/schemas/adcloudcommonDayOfWeek' description: Days of week to filter on. At least one is required. description: WeeklyScheduleFilter specifies a time range on certain days of a week. required: - days CampaignGoalOptimizeAppInstalls: type: object properties: mode: $ref: '#/components/schemas/CampaignGoalOptimizeAppInstallsMode' description: Optimization mode. target_cpi: $ref: '#/components/schemas/adcloudcommonMoney' description: Target cost per install in AdAccount-wide currency. Required when the mode is TARGET_CPI_CENTRIC. rate: type: number format: double description: 'The ratio of the daily budget for the autopilot to spend. Required when the mode is BUDGET_CENTRIC. The rate should be in (0, 2].' margin: type: number format: double description: 'The ratio of the margin for the autopilot to spend. Required when the mode is MARGIN_CENTRIC. The rate should be in [-1.0, 1.0].' CampaignGoalOptimizeAppInstallsMode: type: string enum: - UNKNOWN_MODE - TARGET_CPI_CENTRIC - BUDGET_CENTRIC - MARGIN_CENTRIC - FIXED default: UNKNOWN_MODE description: ' - FIXED: Read-only for AdCloud.' CampaignGoalOptimizeAppReattribution: type: object properties: mode: $ref: '#/components/schemas/CampaignGoalOptimizeAppReattributionMode' description: Optimization mode. rate: type: number format: double description: 'The ratio of the daily budget for the autopilot to spend. The rate should be in (0, 2].' description: Detailed configuration of OPTIMIZE_REATTRIBUTION_FOR_APP goal. CampaignGoalOptimizeAppReattributionMode: type: string enum: - UNKNOWN_MODE - BUDGET_CENTRIC default: UNKNOWN_MODE CampaignGoalOptimizeAppRetention: type: object properties: mode: $ref: '#/components/schemas/CampaignGoalOptimizeAppRetentionMode' description: Optimization mode. target_cpi: $ref: '#/components/schemas/adcloudcommonMoney' description: 'Target cost per install in AdAccount-wide currency. Required when the mode is BUDGET_CENTRIC and rate is unset.' rate: type: number format: double description: 'The ratio of the daily budget for the autopilot to spend. Required when the mode is BUDGET_CENTRIC and target_cpi is unset. The rate should be in (0, 2].' margin: type: number format: double description: 'The ratio of the margin for the autopilot to spend. Required when the mode is MARGIN_CENTRIC. The rate should be in [-1.0, 1.0].' description: Detailed configuration of OPTIMIZE_RETENTION_FOR_APP_UA goal. CampaignGoalOptimizeAppRetentionMode: type: string enum: - UNKNOWN_MODE - BUDGET_CENTRIC - MARGIN_CENTRIC default: UNKNOWN_MODE CampaignGoalOptimizeAppRoas: type: object properties: target_roas: type: number format: double description: 'Target return on advertising spend (ROAS) in percent. For example, a value 312.5 denotes 312.5% ROAS.' revenue_actions: type: array items: type: string description: 'In-app action events having revenue value the AdAccount wants to achieve. Remarkable notes: - Case-sensitive as specified in the post-back from MMP. - ROAS computation will rely on the accompanied revenue value to each action.' target_cpi: $ref: '#/components/schemas/adcloudcommonMoney' description: 'Target cost per install in AdAccount-wide currency. Remarkable notes: - As of June 2019, this value is meaningful only for Campaigns of APP_USER_ACQUISITION type.' mode: $ref: '#/components/schemas/CampaignGoalOptimizeAppRoasMode' description: Optimization mode. rate: type: number format: double description: 'The ratio of the daily budget for the autopilot to spend. Required when the mode is BUDGET_CENTRIC. The rate should be in (0, 2].' margin: type: number format: double description: 'The ratio of the margin for the autopilot to spend. Required when the mode is MARGIN_CENTRIC. The rate should be in [-1.0, 1.0].' required: - revenue_actions CampaignGoalOptimizeAppRoasMode: type: string enum: - UNKNOWN_MODE - BUDGET_CENTRIC - MARGIN_CENTRIC - TARGET_PRIMARY_KPI_CENTRIC default: UNKNOWN_MODE CampaignGoalOptimizeClicksToApp: type: object properties: target_cpc: $ref: '#/components/schemas/adcloudcommonMoney' description: 'Target cost per click in AdAccount-wide currency. Required when the mode is TARGET_CPC_CENTRIC.' mode: $ref: '#/components/schemas/CampaignGoalOptimizeClicksToAppMode' description: Optimization mode. rate: type: number format: double description: 'Budget-centric uses one ratio of daily budget for the autopilot to spend. It''s only for DCPM. Required when the mode is BUDGET_CENTRIC. Its rate should be in (0, 2].' description: Detailed configuration of OPTIMIZE_CPC_FOR_APP_UA goal. CampaignGoalOptimizeClicksToAppMode: type: string enum: - UNKNOWN_MODE - BUDGET_CENTRIC - TARGET_CPC_CENTRIC default: UNKNOWN_MODE CampaignGoalOptimizeClicksToWeb: type: object properties: target_cpc: $ref: '#/components/schemas/adcloudcommonMoney' description: 'Target cost per click in AdAccount-wide currency. Required when the mode is TARGET_CPC_CENTRIC.' mode: $ref: '#/components/schemas/CampaignGoalOptimizeClicksToWebMode' description: Optimization mode. rate: type: number format: double description: 'Budget-centric uses one ratio of daily budget for the autopilot to spend. It''s only for DCPM. Required when the mode is BUDGET_CENTRIC. Its rate should be in (0, 2].' description: Detailed configuration of OPTIMIZE_CPC_FOR_WEB_VISIT goal. CampaignGoalOptimizeClicksToWebMode: type: string enum: - UNKNOWN_MODE - BUDGET_CENTRIC - TARGET_CPC_CENTRIC default: UNKNOWN_MODE CampaignGoalOptimizeCpaForAppRe: type: object properties: action: type: string description: 'In-app action events the AdAccount wants to optimize. Remarkable notes: - Case-sensitive as specified in the post-back from MMP.' reengagement_action: type: string description: 'Re-engagement action to measure re-engaging a user. This action is also used as a cohort base action.' mode: $ref: '#/components/schemas/CampaignGoalOptimizeCpaForAppReMode' description: Optimization mode. rate: type: number format: double description: 'The ratio of the daily budget for the autopilot to spend. Required when the mode is BUDGET_CENTRIC. The rate should be in (0, 2].' description: Detailed configuration of OPTIMIZE_CPA_FOR_APP_RE goal. required: - action CampaignGoalOptimizeCpaForAppReMode: type: string enum: - UNKNOWN_MODE - BUDGET_CENTRIC default: UNKNOWN_MODE CampaignGoalOptimizeCpaForAppUa: type: object properties: action: type: string description: 'In-app action events having revenue value the AdAccount wants to achieve. Remarkable notes: - Case-sensitive as specified in the post-back from MMP.' mode: $ref: '#/components/schemas/CampaignGoalOptimizeCpaForAppUaMode' description: Optimization mode. rate: type: number format: double description: 'The ratio of the daily budget for the autopilot to spend. Required when the mode is BUDGET_CENTRIC. The rate should be in (0, 2].' margin: type: number format: double description: 'The ratio of the margin for the autopilot to spend. Required when the mode is MARGIN_CENTRIC. The rate should be in [-1.0, 1.0].' target_kpi: $ref: '#/components/schemas/adcloudcommonMoney' description: 'Read-only. Operational target KPI value set by System. Populated when the mode is TARGET_PRIMARY_KPI_CENTRIC.' readOnly: true description: Detailed configuration of OPTIMIZE_CPA_FOR_APP_UA goal. required: - action CampaignGoalOptimizeCpaForAppUaMode: type: string enum: - UNKNOWN_MODE - BUDGET_CENTRIC - MARGIN_CENTRIC - TARGET_PRIMARY_KPI_CENTRIC default: UNKNOWN_MODE CampaignGoalOptimizeCpaForWebUa: type: object properties: action: type: string description: 'Web action events having revenue value the AdAccount wants to achieve. Remarkable notes: - Case-sensitive as specified in the post-back from MMP. Note(jiyeon): Currently, we optimize `install` events regardless of this action.' mode: $ref: '#/components/schemas/CampaignGoalOptimizeCpaForWebUaMode' description: Optimization mode. rate: type: number format: double description: 'The ratio of the daily budget for the autopilot to spend. The rate should be in (0, 2].' required: - action CampaignGoalOptimizeCpaForWebUaMode: type: string enum: - UNKNOWN_MODE - BUDGET_CENTRIC default: UNKNOWN_MODE CampaignGoalOptimizeCpaRepeatedForAppUa: type: object properties: action: type: string description: 'In-app action events the AdAccount wants to optimize. Remarkable notes: - Case-sensitive as specified in the post-back from MMP.' mode: $ref: '#/components/schemas/CampaignGoalOptimizeCpaRepeatedForAppUaMode' description: Optimization mode. rate: type: number format: double description: 'The ratio of the daily budget for the autopilot to spend. Required when the mode is BUDGET_CENTRIC. The rate should be in (0, 2].' description: Detailed configuration of OPTIMIZE_CPA_REPEATED_FOR_APP_UA goal. required: - action CampaignGoalOptimizeCpaRepeatedForAppUaMode: type: string enum: - UNKNOWN_MODE - BUDGET_CENTRIC default: UNKNOWN_MODE CampaignGoalOptimizeCpcForAppRe: type: object properties: target_cpc: $ref: '#/components/schemas/adcloudcommonMoney' description: 'Target cost per click in AdAccount-wide currency. Required when the mode is TARGET_CPC_CENTRIC.' reengagement_action: type: string description: 'Re-engagement action to measure re-engaging a user. This action is also used as a cohort base action.' mode: $ref: '#/components/schemas/CampaignGoalOptimizeCpcForAppReMode' description: Optimization mode. rate: type: number format: double description: 'The ratio of the daily budget for the autopilot to spend. The rate should be in (0, 2]. Required when the mode is BUDGET_CENTRIC.' description: Detailed configuration of OPTIMIZE_CPC_FOR_APP_RE goal. CampaignGoalOptimizeCpcForAppReMode: type: string enum: - UNKNOWN_MODE - BUDGET_CENTRIC - TARGET_CPC_CENTRIC default: UNKNOWN_MODE CampaignGoalOptimizeFixedCpm: type: object properties: target_cpm: $ref: '#/components/schemas/adcloudcommonMoney' description: Target cost per click in AdAccount-wide currency. description: Detailed configuration of FIXED_CPM_* goal. required: - target_cpm CampaignGoalOptimizeFixedCpmPacing: type: object properties: target_cpm: $ref: '#/components/schemas/adcloudcommonMoney' description: Target cpm in USD currency (Not in AdAccount currency). pacing_mode: $ref: '#/components/schemas/CampaignGoalOptimizeFixedCpmPacingPacingMode' rate: type: number format: double description: 'Budget consume rate. The rate should be in (0, 2].' description: 'General fixed-cpm goal with pacing option. Currently for FIXED_CPM_FOR_CTV and FIXED_CPM_GENERIC.' required: - target_cpm CampaignGoalOptimizeFixedCpmPacingPacingMode: type: string enum: - NONE - BY_FREQUENCY default: NONE description: Force pacing option. CampaignGoalOptimizeLandingForWebUa: type: object properties: mode: $ref: '#/components/schemas/CampaignGoalOptimizeLandingForWebUaMode' description: Optimization mode. rate: type: number format: double description: 'The ratio of the daily budget for the autopilot to spend. The rate should be in (0, 2].' CampaignGoalOptimizeLandingForWebUaMode: type: string enum: - UNKNOWN_MODE - BUDGET_CENTRIC default: UNKNOWN_MODE CampaignGoalOptimizeRoasForAppRe: type: object properties: target_roas: type: number format: double description: 'Target return on advertising spend (ROAS) in percent. For example, a value 312.5 denotes 312.5% ROAS.' reengagement_action: type: string description: 'Re-engagement action to measure re-engaging a user. This action is also used as a cohort base action.' revenue_actions: type: array items: type: string description: 'In-app action events having revenue value the AdAccount wants to achieve. Remarkable notes: - Case-sensitive as specified in the post-back from MMP. - ROAS computation will rely on the accompanied revenue value to each action.' rate: type: number format: double description: 'The ratio of the daily budget for the autopilot to spend. The rate should be in (0, 2].' description: Detailed configuration of OPTIMIZE_ROAS_FOR_APP_RE goal. required: - revenue_actions CampaignServingStatus: type: object properties: serving_blocked: type: boolean description: serving_blocked is true when this campaign is blocked in the serving side for some reason. serving_blocked_timestamp: type: string format: date-time description: The timestamp of the latest serving block. description: ServingStatus stores current serving status of the campaign, such as whether it is blocked and when it is blocked. CohortSummaryRevenueActionColumn: type: object properties: event: type: string description: Name of an event. event_count: $ref: '#/components/schemas/dspCohortSummaryMetricCount' description: Cumulative count of an event by specified days. user_count: $ref: '#/components/schemas/dspCohortSummaryMetricCount' description: Cumulative count of unique users for an event by specified days. revenue: $ref: '#/components/schemas/dspCohortSummaryMetricRevenue' description: 'Cumulative revenue in contract currency generated by an event by specified days.' description: 'RevenueActionColumn represents a structured column containing cohort metrics by days for a revenue event.' ConversionValueConfigurationItemConversionValueScheme: type: string enum: - UNKNOWN_CONVERSION_VALUE_SCHEME - CONVERSION_VALUE_SCHEME_SINGLE_EVENT - CONVERSION_VALUE_SCHEME_MULTIPLE_EVENTS - CONVERSION_VALUE_SCHEME_CUSTOM_EVENTS - CONVERSION_VALUE_SCHEME_SKAN_V4_EVENTS default: UNKNOWN_CONVERSION_VALUE_SCHEME ConversionValueConfigurationItemCvConfigurationAutoRefresh: type: object properties: enable_auto_refresh: type: boolean description: 'Enables automatically importing the latest SKAdNetwork CV configuration from the integrated MMP and updating CV config items.' refresh_result: $ref: '#/components/schemas/CvConfigurationAutoRefreshAutoRefreshResult' description: Result status of auto refresh. readOnly: true refresh_error_message: type: string description: Auto refresh error message in case the refresh request failed. readOnly: true last_auto_refreshed_at: type: string format: date-time description: Timestamp when the last auto SKAdNetwork CV configuration refresh occurred. readOnly: true description: Settings for automatically importing and updating SKAdNetwork conversion value configuration from MMP. ConversionValueConfigurationItemCvConfigurationForCustomEvents: type: object properties: cv_events: type: object additionalProperties: $ref: '#/components/schemas/CvConfigurationForCustomEventsEventList' description: 'Information on relationships between conversion value and events for custom event scheme. The key of this map is the registered conversion value between 1 to 63. The value of this map is the list of events for each conversion value.' ConversionValueConfigurationItemCvConfigurationForCustomEventsEventInfo: type: object properties: event_name: type: string description: In-app event. event_value: type: string description: 'String set by the developer containing data to be decoded by the AdAccount in their systems. Typically this is in the format of a JSON.' revenue_interval: $ref: '#/components/schemas/adcloudcommonFloatingPointRange' description: Optional. Revenue range for the event. predict_revenue_interval: $ref: '#/components/schemas/adcloudcommonFloatingPointRange' title: 'Optional. Revenue range for customer''s predicted future spending. Reference: https://mlc.atlassian.net/browse/MMP-166' event_counter: type: integer format: int32 description: 'Number of times the event is duplicated on decoding. Typically it represents the number of times the user performed a given action. Minimum value 1.' hours_from_install: type: integer format: int32 description: 'Hours elapsed since the install. Minimum value: 1. The value for all rows of a given conversion_value must be identical. Meaning different values for different conversion values is permitted.' title: 'EventInfo holds data for decoding conversion value to events. Reference: https://support.appsflyer.com/hc/en-us/articles/360014696297-Custom-conversion-value-decode-for-SKAdNetwork#decode-csv-file-specification' required: - event_name - event_counter - hours_from_install ConversionValueConfigurationItemCvConfigurationForMultipleEvents: type: object properties: cv_events: type: object additionalProperties: type: string description: 'Information on relationships between conversion value and event name for multiple events scheme. The key of this map is the registered conversion value between 0 to 5. The value of this map is the event name.' ConversionValueConfigurationItemCvConfigurationForSingleEvent: type: object properties: cv_revenue_events: type: object additionalProperties: $ref: '#/components/schemas/ConversionValueConfigurationItemCvConfigurationForSingleEventEventInfo' description: 'Information on relationships between conversion value and (event name & revenue interval) for single event scheme. The key of this map is the registered conversion value between 1 to 63. The value of this map is a EventInfo message. EventInfo without revenue value should be unique. For the same event name, conversion value should be consecutive. Range min value cannot be smaller than previous range''s max value. At least 4 Purchase Value should be registered for each event.' ConversionValueConfigurationItemCvConfigurationForSingleEventEventInfo: type: object properties: event_name: type: string revenue_interval: $ref: '#/components/schemas/adcloudcommonFloatingPointRange' description: 'Revenue value cannot be negative. Range min value cannot be larger than the range max value.' ConversionValueConfigurationItemCvConfigurationForSkanV4Events: type: object properties: postbacks: type: array items: type: object $ref: '#/components/schemas/CvConfigurationForSkanV4EventsPostback' CopyCreativeGroupsSyncResponseCopyCreativeGroupsSyncFailedLog: type: object properties: failed_creative_group_id: type: string description: The ID of failed CreativeGroup to be copied. failed_reason: type: string description: The reason of why copying is failed. description: The failed log which contains failed CreativeGroup ID and reason. CopyCreativesSyncResponseCopyCreativesSyncResult: type: object properties: creative_id: type: string description: The ID of Creative to be copied. is_success: type: boolean description: The result of copying the Creative. failed_reason: type: string description: 'The reason of why copying is failed. In case of success, this would be empty.' description: The result which contains Creative ID and its detailed result of copying. CreateAssetUploadSessionRequestAssetUploadSessionInfo: type: object properties: asset_kind: $ref: '#/components/schemas/commonAssetKind' description: The kind of asset. mime_type: type: string description: MIME type of the asset to upload. required: - asset_kind - mime_type CreativeFeatureDynamicCreative: type: object properties: app_icon_url: type: string description: An app icon URL used by MRAID template. brand_logo_url: type: string description: A brand image URL used by MRAID template. business_title: type: string description: A business title used by template. cta_text: type: string description: Call-To-Action text. cta_color: type: string description: CTA button(background) color, do not confuse with cta_text_color. image_border_color: type: string description: Border color around image from catalog. title_preamble: type: string description: preamble for title. main_text: type: string description: A custom text for some templates. main_text_color: type: string description: Main text color. cta_text_color: type: string description: CTA text color, do not confuse with cta_color. background_color: type: string description: background color of dynamic creative. price_locale: type: string description: Locale for creatives. It is used to render prices. disclaimer_text: type: string description: Disclaimer text. disclaimer_text_color: type: string description: Disclaimer text color. sponsored_by: type: string description: Brand name of the sponsor/advertiser. description: Detailed configuration of DYNAMIC_CREATIVE feature. CreativeGroupActionType: type: string enum: - UNKNOWN_TYPE - CREATE - UPDATE - START_REVIEW - DISAPPROVE - APPROVE - REQUEST_REVIEW default: UNKNOWN_TYPE description: "Enumeration of all supported CreativeGroup action types.\n\n - UNKNOWN_TYPE: This value is not part of\ \ the specification.\n - CREATE: The user created the CreativeGroup.\nThe status of a new Creative will be set to\ \ SUBMITTED upon creation.\n - UPDATE: The user updated the CreativeGroup.\nThe status of the CreativeGroup may be\ \ set to SUBMITTED for some significant updates.\n - START_REVIEW: The reviewer user started the review of the CreativeGroup.\n\ The status of the CreativeGroup will be set to UNDER_REVIEW.\n - DISAPPROVE: The reviewer user reviewed and disapproved\ \ the CreativeGroup.\nThe status of the CreativeGroup will be set to DISAPPROVED.\n - APPROVE: The reviewer user reviewed\ \ and approved the CreativeGroup.\nThe status of the CreativeGroup will be set to APPROVED.\n - REQUEST_REVIEW: Request\ \ the CreativeGroup to be reviewed. The CreativeGroup could previously be\nin UNDER_REVIEW, APPROVED or DISAPPROVED\ \ state." CreativeHtmlRequirementAttributesAutoPlayAudioType: type: string enum: - UNKNOWN_AUTO_PLAY_AUDIO_TYPE - AUTO_PLAY_AUDIO_TYPE_MUTED - AUTO_PLAY_AUDIO_TYPE_AUTO_PLAY - AUTO_PLAY_AUDIO_TYPE_CONTROLLABLE default: UNKNOWN_AUTO_PLAY_AUDIO_TYPE description: "The Creative plays audio automatically; i.e., it starts muted. It may not be specified.\n\nIt is NOT SPECIFIED.\n\ \n - AUTO_PLAY_AUDIO_TYPE_MUTED: It does not play audio automatically.\n - AUTO_PLAY_AUDIO_TYPE_AUTO_PLAY: It plays\ \ audio automatically.\n - AUTO_PLAY_AUDIO_TYPE_CONTROLLABLE: It is allowed to be changed with respect to target ad\ \ exchange." CreativeHtmlRequirementAttributesCustomCloseType: type: string enum: - UNKNOWN_CUSTOM_CLOSE_TYPE - CUSTOM_CLOSE_TYPE_NONE - CUSTOM_CLOSE_TYPE_ENABLED - CUSTOM_CLOSE_TYPE_CONTROLLABLE default: UNKNOWN_CUSTOM_CLOSE_TYPE description: "The Creative uses useCustomClose() functionally in MRAID. It may not be specified.\n\nIt is NOT SPECIFIED.\n\ \n - CUSTOM_CLOSE_TYPE_NONE: It does not use useCustomClose().\n - CUSTOM_CLOSE_TYPE_ENABLED: It uses useCustomClose().\n\ \ - CUSTOM_CLOSE_TYPE_CONTROLLABLE: It is allowed to be changed with respect to target ad exchange." CreativeHtmlSizeAttributesFixed: type: object properties: width: type: integer format: int64 height: type: integer format: int64 CreativeReviewCreativeGroupInfo: type: object properties: id: type: string description: ID of the CreativeGroup. title: type: string description: A descriptive name of the CreativeGroup. description: Information of CreativeGroup that are using this Creative. CreativeReviewPerExchangeReasonDetail: type: string enum: - UNKNOWN_DETAIL - CTA_TEXT_INVALID - FILE_SIZE_TOO_LARGE default: UNKNOWN_DETAIL description: "ReasonDetail describes the reason the Creative was DISAPPROVED. It applies to a few, standardized cases.\n\ \n - CTA_TEXT_INVALID: The CTA text for native Creatives does not belong in a predefined list.\n - FILE_SIZE_TOO_LARGE:\ \ The size of the main asset exceeds a predefined limit." CreativeReviewPerExchangeReviewAction: type: object properties: assigned_status: $ref: '#/components/schemas/dspCreativeReviewPerExchangeStatus' description: The status assigned as the result of an action. comment: type: string description: Comment for the action. created_at: type: string format: date-time description: Created time. readOnly: true reason_detail: $ref: '#/components/schemas/CreativeReviewPerExchangeReasonDetail' description: The ReasonDetail assigned as the result of an action. description: The details of an action taken on the CreativeReview. CreativeRichCustomHtmlSrcPlayableADSourceData: type: object properties: type: $ref: '#/components/schemas/CreativeRichCustomHtmlSrcPlayableADSourceType' description: Type of the source. value: type: string description: 'When type is PLAYABLE_AD_SOURCE_TYPE_URL, then URL of the uploaded HTML file. When type is PLAYABLE_AD_SOURCE_TYPE_TAG, then the full tag string.' CreativeRichCustomHtmlSrcPlayableADSourceType: type: string enum: - UNKNOWN_PLAYABLE_AD_SOURCE_TYPE - PLAYABLE_AD_SOURCE_TYPE_URL - PLAYABLE_AD_SOURCE_TYPE_TAG default: UNKNOWN_PLAYABLE_AD_SOURCE_TYPE description: " - PLAYABLE_AD_SOURCE_TYPE_URL: Source is a URL of the playable ad html. (facebook style).\n - PLAYABLE_AD_SOURCE_TYPE_TAG:\ \ Source is a playable ad html tag generated by the third party. (tresensa, spaceback, luna, playable factory, craftsmanplus)." CreativeVideoSrcTargetAdPosition: type: string enum: - DEFAULT - FIRST_AD_ONLY - LAST_AD_ONLY default: DEFAULT description: Target ad position for the video source. CreativeVideoSrcTranscodingInfo: type: object properties: status: $ref: '#/components/schemas/CreativeVideoSrcTranscodingInfoStatus' description: Status of the transcoding. failed_reason: type: string description: Error message for the FAILED status. CreativeVideoSrcTranscodingInfoStatus: type: string enum: - UNKNOWN_STATUS - IN_PROGRESS - SUCCEEDED - FAILED default: UNKNOWN_STATUS description: " - IN_PROGRESS: The transcoding is in progress.\n - SUCCEEDED: The transcoding has succeeded.\n - FAILED:\ \ The transcoding has failed.\nDetailed reason can be found from failed_reason." CustomAudienceSetApp: type: object properties: product_id: type: string description: The ID of the Product. sliding_window_duration: $ref: '#/components/schemas/commonTimeDuration' description: The duration of time for which this condition is effective before now. description: 'App matches a user based on app engagement within a time window. Use AppEvent when targeting a specific event by name.' CustomAudienceSetAppEvent: type: object properties: product_id: type: string description: The ID of the Product of which PostbackIntegration info is used. event: type: string description: A case-sensitive string name of an event. (e.g. install, purchase). sliding_window_duration: $ref: '#/components/schemas/commonTimeDuration' description: The duration of time for which this condition is effective before now. CustomAudienceSetCustomAudienceCondition: type: object properties: app_events: type: array items: type: object $ref: '#/components/schemas/CustomAudienceSetAppEvent' user_lists: type: array items: type: string description: 'IDs of pre-defined CustomerSets. IP CustomerSet is not included.' apps: type: array items: type: object $ref: '#/components/schemas/CustomAudienceSetApp' description: Matches users by app engagement regardless of event type. CustomerActivityActivityCondition: type: object properties: product_id: type: string description: The ID of the Product of which PostbackIntegration info is used. event: type: string description: A case-sensitive string name of an event. (e.g. install, purchase). sliding_window_duration: $ref: '#/components/schemas/commonTimeDuration' description: The duration of time for which this condition is effective before now. CustomerSetCustomerSetStatusDetail: type: object properties: connection_method: $ref: '#/components/schemas/CustomerSetStatusDetailConnectionMethod' error_id: $ref: '#/components/schemas/CustomerSetStatusDetailErrorId' error_description: type: string description: Error description is a detailed description of the error. csv_file_size: type: integer format: int32 title: CSV file size is the size of the CSV file in bytes. (Deprecated) aud_size: type: integer format: int32 description: Audience size is the size of the audience in bytes. CustomerSetFileUpdateHistory: type: object properties: status: $ref: '#/components/schemas/dspCustomerSetStatus' status_detail: $ref: '#/components/schemas/CustomerSetCustomerSetStatusDetail' updated_at: type: string format: date-time description: Updated at is the timestamp when the status is changed. CustomerSetFileUpdateInfo: type: object properties: status: $ref: '#/components/schemas/FileUpdateInfoUpdateStatus' description: Update status. timestamp: type: string format: date-time description: Update timestamp. file_name: type: string description: Updated file name. CustomerSetStatusDetailConnectionMethod: type: string enum: - UNKNOWN_METHOD - CLOUD_API - MCP_UPLOAD - AF_AUDIENCE_BUILDER - BESPOKE default: UNKNOWN_METHOD description: "Connection method is an indicator of how the customer set file is updated.\n\n - CLOUD_API: Update via\ \ cloud API\n - MCP_UPLOAD: MCP Upload\n - AF_AUDIENCE_BUILDER: AF Audience Builder\n - BESPOKE: Bespoke" CustomerSetStatusDetailErrorId: type: string enum: - UNKNOWN_ERROR_ID - TAGGING_ERROR - REQUEST_ERROR - PREPROCESSING_ERROR - GENERIC_ERROR default: UNKNOWN_ERROR_ID description: Error id is an indicator of the error type. CvConfigurationAutoRefreshAutoRefreshResult: type: string enum: - UNKNOWN - OK - ERROR default: UNKNOWN CvConfigurationForCustomEventsEventList: type: object properties: events: type: array items: type: object $ref: '#/components/schemas/ConversionValueConfigurationItemCvConfigurationForCustomEventsEventInfo' description: events hold multiple EventInfo. CvConfigurationForSkanV4EventsPostback: type: object properties: postback_sequence_index: type: integer format: int32 measurement_window: type: integer format: int32 coarse_grained_values: type: object additionalProperties: $ref: '#/components/schemas/CvConfigurationForCustomEventsEventList' description: 'Information on relationships between coarse-grained conversion value and its detailed events. The possible keys of the map are low, medium or high.' fine_grained_values: type: object additionalProperties: $ref: '#/components/schemas/CvConfigurationForCustomEventsEventList' description: 'Information on relationships between fine-grained conversion value and its detailed events. The key of this map is the registered conversion value between 1 to 63.' FileUpdateInfoUpdateStatus: type: string enum: - UNKNOWN_STATUS - IN_PROGRESS - SUCCESS - FAILED default: UNKNOWN_STATUS description: " - IN_PROGRESS: Update is in progress.\n - SUCCESS: Update succeed.\n - FAILED: Update failed. Please\ \ check the contents format." InAppEventConditionAttribution: type: string enum: - UNKNOWN_ATTRIBUTION - ATTRIBUTION_ALL - ATTRIBUTED - UNATTRIBUTED default: UNKNOWN_ATTRIBUTION InAppEventConditionRevenue: type: string enum: - UNKNOWN_REVENUE - REVENUE_ALL - REVENUE_TRUE - REVENUE_FALSE default: UNKNOWN_REVENUE InAppEventConditionTimeWindow: type: string enum: - UNKNOWN_TIME_WINDOW - TIME_WINDOW_D30 - D30 - TIME_WINDOW_D90 - D90 - TIME_WINDOW_TODAY default: UNKNOWN_TIME_WINDOW description: " - TIME_WINDOW_D30: Query with recent 30 days. (Default).\n - TIME_WINDOW_D90: Query with recent 90 days.\n\ \ - TIME_WINDOW_TODAY: Query with today’s data." LaunchNoticeNoticeMessage: type: string enum: - UNKNOWN_MESSAGE - MMP_PROBABILISTIC_ATTRIBUTION_STATUS_DISABLED - MMP_VIEW_THROUGH_PROBABILISTIC_ATTRIBUTION_STATUS_DISABLED - MMP_ADVANCED_PRIVACY_STATUS_ENABLED - MMP_PROBABILISTIC_ATTRIBUTION_STATUS_UNKNOWN - CAMPAIGN_WILL_PAUSE_IF_ADVANCED_PRIVACY_ENABLED_AFTER_48H default: UNKNOWN_MESSAGE description: "- UNKNOWN_MESSAGE: Default fallback for unrecognized message types.\n - MMP_PROBABILISTIC_ATTRIBUTION_STATUS_DISABLED:\ \ MMP Probabilistic Attribution (PA) is disabled. User should enable PA from MMP side.\n - MMP_VIEW_THROUGH_PROBABILISTIC_ATTRIBUTION_STATUS_DISABLED:\ \ View-Through Probabilistic Attribution (VT PA) is disabled in MMP settings.\n - MMP_ADVANCED_PRIVACY_STATUS_ENABLED:\ \ Appsflyer Advanced Privacy is currently enabled.\n - MMP_PROBABILISTIC_ATTRIBUTION_STATUS_UNKNOWN: The current status\ \ of Probabilistic Attribution cannot be determined.\n - CAMPAIGN_WILL_PAUSE_IF_ADVANCED_PRIVACY_ENABLED_AFTER_48H:\ \ The campaign is scheduled to pause in 48 hours if Advanced Privacy remains enabled." title: NoticeMessage indicates the message user should confirm LaunchNoticeNoticeType: type: string enum: - UNKNOWN - WARNING - DISCLAIMER default: UNKNOWN description: "NoticeType defines the severity or category of the notice.\n\n - WARNING: Warning: Informational message\ \ that does not block the launch but requires attention.\n - DISCLAIMER: Disclaimer: Explicit agreement or acknowledgement\ \ is required from the user." ListCampaignsRequestFetchOption: type: string enum: - UNKNOWN_FETCH_OPTION - FETCH_ALL - FETCH_ONLY_DELETED default: UNKNOWN_FETCH_OPTION description: " - FETCH_ALL: Fetch all Campaigns including deleted and not deleted.\n - FETCH_ONLY_DELETED: Fetch only\ \ deleted Campaigns." ListCreativesRequestOrderBy: type: object properties: key: $ref: '#/components/schemas/ListCreativesRequestOrderByKey' is_descending: type: boolean ListCreativesRequestOrderByKey: type: string enum: - UNKNOWN_ORDER_BY - UPDATED_AT default: UNKNOWN_ORDER_BY ListReportFiltersResponseReportFilter: type: object properties: id: $ref: '#/components/schemas/dspReportFilterDimension' description: Dimension of the report. display_name: type: string description: Display name of the dimension. options: type: array items: type: object $ref: '#/components/schemas/ListReportFiltersResponseReportFilterOption' ListReportFiltersResponseReportFilterOption: type: object properties: display_name: type: string value: type: string description: A pair of the value and display_name for each dimension. LocationSetZipCodeSet: type: object properties: zipcodes: type: array items: type: string description: Zipcodes to represent areas to target. country: type: string description: Uppercase Country code in ISO 3166-1 alpha-2. MmpContextAdjustContext: type: object properties: url_host_universal_link: type: string title: Immutable. Ends with ".adj.st" ex) moloco.adj.st url_host_branded_link: type: string title: Immutable. Ends with ".go.link" ex) moloco.go.link MmpIntegrationConversionValueConfigurationItem: type: object properties: effective_date: type: string description: The start date of the CV configuration in the form of YYYY-MM-DD. scheme: $ref: '#/components/schemas/ConversionValueConfigurationItemConversionValueScheme' description: 'Scheme of CV configuration. There are two types of scheme single event scheme and multiple events scheme.' cv_single: $ref: '#/components/schemas/ConversionValueConfigurationItemCvConfigurationForSingleEvent' cv_multi: $ref: '#/components/schemas/ConversionValueConfigurationItemCvConfigurationForMultipleEvents' cv_custom: $ref: '#/components/schemas/ConversionValueConfigurationItemCvConfigurationForCustomEvents' cv_skan_v4: $ref: '#/components/schemas/ConversionValueConfigurationItemCvConfigurationForSkanV4Events' auto_refresh: $ref: '#/components/schemas/ConversionValueConfigurationItemCvConfigurationAutoRefresh' description: Settings for SKAdNetwork conversion value configuration auto-refresh. description: 'Conversion value configuration. Show the valid item among the history in the storage entity. (Most recent item of which the effective date is not later than current date.) Use case in MCP: https://help.moloco.com/hc/en-us/articles/1500012981641-SKAdNetwork-Conversion-Value-Configuration- .' MmpIntegrationMmpContext: type: object properties: adjust: $ref: '#/components/schemas/MmpContextAdjustContext' description: 1 is deprecated. Do not reuse it. PolicyEvaluatorType: type: string enum: - UNKNOWN_EVALUATOR - EVALUATOR_TEST_CATALOG_DEPENDENT - EVALUATOR_TEST_CATALOG_INDEPENDENT - EVALUATOR_RANDOM - EVALUATOR_LR default: UNKNOWN_EVALUATOR description: EvaluatorType defines the type of evaluator for the model. PolicyFunctionConfigGameConfig: type: object properties: game_id: type: string description: Game id. it should correspond to GameID of dcr/api.proto. PolicyFunctionConfigMcmItemRecommendationConfig: type: object properties: mcm_platform_id: type: string title: Platform identifier for MCM Item Recommendation. (e.g. MOLOCO_PORTAL_DEMO) inventory_id: type: string title: Inventory identifier for MCM Item Recommendation. (e.g. home_recommendation) PolicyFunctionConfigModelConfig: type: object properties: sourcer_type: $ref: '#/components/schemas/PolicySourcerType' evaluator_type: $ref: '#/components/schemas/PolicyEvaluatorType' evaluator_suffix: type: string user_signal_window_hours: type: integer format: int32 PolicyFunctionConfigNextItemSelectionConfig: type: object description: 'NEXT_ITEM_SELECTION PolicyFunction''s config. NEXT tunes its item selection logic at the Config level rather than the PolicyFunction level.' PolicyFunctionConfigTrendConfig: type: object properties: name: type: string description: TREND PolicyFunction's config. PolicyItemCapper: type: object properties: frequency: $ref: '#/components/schemas/PolicyItemCapperFrequency' description: "Item-specific capper configurations.\nThe configuration in this message is enforced:\n - across AdAccounts,\n\ \ - across Campaigns,\n - across AdGroups,\n - across CreativeGroups, and\n - across Creatives." PolicyItemCapperFrequency: type: object properties: period: type: string description: 'The period is represented in a format {INTEGER}[smhdw]. For example, "1m" indicates 1 minute. When this field is empty, the system default cooling time is used.' max_exposures: type: integer format: int32 description: The max number of exposures of a CatalogItem within a period of time. description: "Frequency represents frequency capping. One can specify\n\"at most 3 exposures per 1 hour\" by setting:\n\ \ {\n \"period\": \"1h\",\n \"max_exposures\": 3\n }\nThis means, when a user sees a CatalogItem 3 times,\ \ he/she won't\nsee the same CatalogItem again for 1 hour." PolicyPolicyFunction: type: string enum: - UNKNOWN_POLICY - RANDOM_SELECTION - MOST_RECENT_VIEW - IN_CART - GLOBAL_TREND - TREND - COMBINED_EVENTS_RECENCY - FREQUENTLY_BOUGHT_TOGETHER - FREQUENTLY_SEEN_TOGETHER - KEYWORD_SEARCH_WITH_CLIENT_RESULT - COMBINED_EVENTS_RECENCY_WITH_KEYWORD_SEARCH - MODEL - GAME - RMP_AUDIENCE_EXTENSION - MCM_ITEM_RECOMMENDATION - NEXT_ITEM_SELECTION default: UNKNOWN_POLICY description: "PolicyFunction defines algorithms for selecting CatalogItems or CreativeElements for a game.\n\n - IN_CART:\ \ GLOBAL_TREND will be deprecated and replaced by TREND. During A/B testing, we will keep this not to break the test.\n\ \ - MODEL: For model policies, the policy enum is in the form of MODEL_{SOURCER_TYPE}_{EVALUATOR_TYPE}_{EVALUATOR_SUB_TYPE}\n\ \ - GAME: GAME policy is used to select Creative elements of game.\n - RMP_AUDIENCE_EXTENSION: Policy for RMP Audience\ \ Extension.\n - MCM_ITEM_RECOMMENDATION: Policy for MCM Item Recommendation.\n - NEXT_ITEM_SELECTION: Policy for\ \ NEXT Item Selection." PolicyPolicyFunctionConfig: type: object properties: trend: $ref: '#/components/schemas/PolicyFunctionConfigTrendConfig' description: TREND PolicyFunction's config. model: $ref: '#/components/schemas/PolicyFunctionConfigModelConfig' game: $ref: '#/components/schemas/PolicyFunctionConfigGameConfig' mcm_item_recommendation: $ref: '#/components/schemas/PolicyFunctionConfigMcmItemRecommendationConfig' next_item_selection: $ref: '#/components/schemas/PolicyFunctionConfigNextItemSelectionConfig' description: 'Configuration for PolicyFunction. Some PolicyFunction requires an instance of this message to get a function: Policy -> CatalogItem/CreativeElement list.' PolicySourcerType: type: string enum: - UNKNOWN_SOURCER - SOURCER_TEST_CATALOG_DEPENDENT - SOURCER_TEST_CATALOG_INDEPENDENT - SOURCER_DEFAULT - SOURCER_USER_SIGNAL - SOURCER_TRENDS - SOURCER_RELATED_ITEMS - SOURCER_AUCTION_ITEMS default: UNKNOWN_SOURCER description: SourcerType defines the type of sourcer for the model. PostbackIntegrationEventSummaryEventTypeSummary: type: object properties: event_name: type: string description: The name of the in-app event. total_count: type: string format: int64 description: Number of events of the event type. attributed_count: type: string format: int64 description: Number of attributed events of the event type. is_revenue: type: boolean description: The flag that specifies whether the event comes with revenue value. total_revenue: type: number format: double description: 'The total revenue from the event type. Its currency follows the currency of the ad account.' total_revenue_usd: type: number format: double description: The USD total revenue from the event type. ProductAppProperties: type: object properties: bundle_id: type: string description: App bundle ID. Immutable. category: type: string description: 'The main IAB content category of the App. This field is now output only and will be removed after v1.10. Before that, it is auto-filled from the categories field. Please use ''categories'' field instead. Valid category values can be found in section "5.1 Content Categories" in the [OpenRTB API Specification] (https://github.com/openrtb/OpenRTB/blob/master/OpenRTB-API-Specification-Version-2-3-1-FINAL.pdf).' readOnly: true categories: type: array items: type: string description: 'The IAB categories of the App. All the categories must be valid IAB categories. On create Product, the system checks the App Metadata Inventory: if the app is found, the Inventory values override user input; otherwise, the API uses the provided input. This field is editable only when the app is not in Inventory, and becomes read-only if the app exists there. Valid category values can be found in section "5.1 Content Categories" in the [OpenRTB API Specification] (https://github.com/openrtb/OpenRTB/blob/master/OpenRTB-API-Specification-Version-2-3-1-FINAL.pdf).' category_readable: type: string title: App category in a human-readable format from the app store rating: type: number format: double description: App rating in the range of [0, 5]. rating_cnt: type: string format: int64 title: Total number of app ratings from the app store app_store_url: type: string description: App store URL for Google Play, Apple App Store or Other App Markets. available_countries: type: array items: type: string description: 'Country codes where the app is available in the store. The value format is ISO-3166-1 Alpha-2 using uppercase letters only, such as "KR" or "US".' unavailable_countries: type: array items: type: string description: 'Country codes where the app is unavailable in the store. The value format is ISO-3166-1 Alpha-2 using uppercase letters only, such as "KR" or "US".' rtb_bundle_ids: type: array items: type: string description: 'RTB bundle names that related to the target app for which a Campaign runs. This field is useful when the target app and/or its family apps send out bid requests to the exchanges: (1) by nature, the Campaign must not deliver ad to the AdAccount''s own apps; (2) it''s better to ignore such apps for ads serving model training.' postback_integration: $ref: '#/components/schemas/dspPostbackIntegration' description: Active postback integration for the app. mmp_integration: $ref: '#/components/schemas/dspMmpIntegration' description: MmpIntegration of the Product. Immutable. skadn_mmp_integration: $ref: '#/components/schemas/dspMmpIntegration' description: SKAN MmpIntegration of the Product. Immutable. content_rating: type: string description: Content rating(App store age information) of the App. storekit_enabled: type: boolean description: StoreKit can be applied only for iOS app. autoinline_enabled: type: boolean description: AutoInline can be applied only for Android app. localized_app_name: type: object additionalProperties: type: string title: Field for mapping language to it’s app name readOnly: true localized_app_icon_url: type: object additionalProperties: type: string description: Field for url of app icon. readOnly: true localized_app_screenshots: type: object additionalProperties: $ref: '#/components/schemas/AppPropertiesAppScreenshots' description: App screenshots from the app store. readOnly: true app_event_types: type: object additionalProperties: $ref: '#/components/schemas/AppPropertiesAppEventType' description: 'Information on relationships between in-app events and its event type. This field is to categorize in-app events and categorized event types for each in-app event are used to optimize training of ML model.' description: type: string title: App description from the app store short_description: type: string description: Short description (promo text) from the app store. ios_primary_measurement: $ref: '#/components/schemas/AppPropertiesIosPrimaryMeasurement' description: Primary measurement used for iOS apps. ios_secondary_measurement: $ref: '#/components/schemas/AppPropertiesIosSecondaryMeasurement' description: Secondary measurement used for iOS apps. ios_custom_measurement: type: string title: 'Custom secondary measurement label for iOS apps. Set only when ios_secondary_measurement == IOS_SECONDARY_MEASUREMENT_CUSTOM. If set when the secondary measurement is not CUSTOM, this field must be empty' description: 'AppProperties defines the App type Product specific properties. Should contain only one of ''app'' or ''web''.' required: - bundle_id ProductDynamicCreativeProperty: type: object properties: permission: type: boolean description: Permission to use dynamic CreativeGroups. description: Dynamic Creative specific properties. ProductSuspensionAction: type: object properties: user_name: type: string description: Name who judges the product to be suspended. readOnly: true user_email: type: string description: Email who judges the product to be suspended. readOnly: true reason: type: string description: The reason for the product suspension. kind: $ref: '#/components/schemas/ProductSuspensionActionKind' readOnly: true type: $ref: '#/components/schemas/ProductSuspensionActionType' effective_from: type: string format: date-time description: The time from the app suspension will have been effective. effective_until: type: string format: date-time description: 'The time until the app suspension will have been effective. If the value of Type is set to STOP_SUSPENSION, SUSPEND_INDEFINITELY, there is no need to enter a value and the system automatically enters a value for you.' created_at: type: string format: date-time description: The time when the current suspension action is created. readOnly: true description: 'Product suspension action to block campaign activation under the product. The value can be updated only on Moloco''s end.' ProductSuspensionActionKind: type: string enum: - UNKNOWN_KIND - CREATE - UPDATE default: UNKNOWN_KIND description: "The kind to represent whether the current action is newly created, or is for updating the previous action.\n\ \n - CREATE: This suspension action is independently created.\n - UPDATE: This suspension action is for updating the\ \ previous suspension action." ProductSuspensionActionType: type: string enum: - UNKNOWN_TYPE - SUSPEND_UNTIL - SUSPEND_INDEFINITELY - STOP_SUSPENSION default: UNKNOWN_TYPE description: "The type which the current action achieves.\n\n - SUSPEND_UNTIL: The current action is for product suspension\ \ until someday.\n - SUSPEND_INDEFINITELY: The current action is for product suspension indefinitely.\n - STOP_SUSPENSION:\ \ The current action is to stop product suspension." ProductWebProperties: type: object properties: category: type: string description: 'The main IAB content category of the web product. When creating a WEB product, provide exactly one of ''category'' or ''categories''; the other field is derived automatically. Providing both is rejected. REQUIRED was dropped to allow ''categories''-only WEB creates; BRAND products reuse this message via ''brand.web'' and still require ''category'' (enforced at the API layer). Valid category values can be found in section "5.1 Content Categories" in the [OpenRTB API Specification] (https://github.com/openrtb/OpenRTB/blob/master/OpenRTB-API-Specification-Version-2-3-1-FINAL.pdf)' landing_url: type: string description: 'URL of the final destination page the audience users will be redirected to. Length of the URL should not exceed 10000 characters.' categories: type: array items: type: string description: 'Multiple IAB categories of the web product. When creating a product, provide exactly one of ''category'' or ''categories''; the other field is derived automatically. Providing both is rejected. Valid category values can be found in section "5.1 Content Categories" in the [OpenRTB API Specification] (https://github.com/openrtb/OpenRTB/blob/master/OpenRTB-API-Specification-Version-2-3-1-FINAL.pdf).' description: 'WebProperties defines the Web type Product specific properties. Should contain only one of ''app'' or ''web''.' ReadWorkplaceSummaryRequestMonthRange: type: object properties: start: type: string description: Start month in the 'YYYY-MM' format. end: type: string description: End month in the 'YYYY-MM' format. description: Month range. required: - start - end ReportExportPartner: type: string enum: - UNKNOWN_PARTNER - SINGULAR - APPSFLYER - TENJIN - BIDALGO - APPANNIE - APPSUMER - ADJUST - KOCHAVA - AIRBRIDGE - BRANCH - JUSTTRACK default: UNKNOWN_PARTNER description: "Partner enumerates the reporting solution partners to whom we've integrated.\n\n - SINGULAR: Singular.\n\ \ - APPSFLYER: AppsFlyer.\n - TENJIN: Tenjin.\n - BIDALGO: Bidalgo.\n - APPANNIE: Appannie.\n - APPSUMER: Appsumer.\n\ \ - ADJUST: Adjust.\n - KOCHAVA: Kochava.\n - AIRBRIDGE: AirBridge.\n - BRANCH: Branch.\n - JUSTTRACK: JustTrack." ReportOptionalMetric: type: string enum: - UNKNOWN_REPORT_METRIC - VIDEO_PLAY_PROGRESS - ENGAGED_VIEWS - ENGAGED_CLICKS default: UNKNOWN_REPORT_METRIC description: Optional Metric enumerates available breakdown metrics. SKAdNetworkInputCustomOption: type: string enum: - UNKNOWN_SKAN_CUSTOM_OPTION - SKAN_CUSTOM_OPTION_MMP_ATTRIBUTABLE - SKAN_CUSTOM_OPTION_BI_ATTRIBUTABLE - SKAN_CUSTOM_OPTION_NON_ATTRIBUTABLE - SKAN_CUSTOM_OPTION_SKAN_ATTRIBUTABLE default: UNKNOWN_SKAN_CUSTOM_OPTION description: "CustomOption enumerates all the available traffic.\nWhile the targeting_state other than 'TARGET_CUSTOM'\ \ is a pre-defined set of traffic,\nCustomOption enables configuring the targeted traffic in a custom way.\n\nThis\ \ value is not part of the specification.\n\n - SKAN_CUSTOM_OPTION_MMP_ATTRIBUTABLE: This option target traffic which\ \ is iOS < 14.5 and SKAdNetwork incompatible.\n - SKAN_CUSTOM_OPTION_BI_ATTRIBUTABLE: This option target traffic which\ \ is iOS < 14.5 and SKAdNetwork compatible.\n - SKAN_CUSTOM_OPTION_NON_ATTRIBUTABLE: This option target traffic which\ \ is iOS >= 14.5 and SKAdNetwork incompatible.\n - SKAN_CUSTOM_OPTION_SKAN_ATTRIBUTABLE: This option target traffic\ \ which is iOS >= 14.5 and SKAdNetwork compatible." SKAdNetworkInputTargetingState: type: string enum: - UNKNOWN_TARGETING_STATE - TARGET_DO_NOT_CARE - TARGET_ALL - TARGET_SKADN_ONLY - TARGET_NON_SKADN_ONLY - TARGET_CUSTOM default: UNKNOWN_TARGETING_STATE description: "Enumeration of all supported targeting state w.r.t SKAdNetwork traffic.\nTARGET_ALL, TARGET_SKADN_ONLY,\ \ TARGET_NON_SKADN_ONLY is a predefined set of traffic.\nTARGET_CUSTOM is to support DIY configuration of traffic.\n\ \nThis value is not part of the specification.\n\n - TARGET_DO_NOT_CARE: Do not care whether the Campaign targets\ \ SKAdNetwork traffic or not.\n - TARGET_ALL: Target all traffic including SKAdNetwork and others.\nIt includes SKAN_CUSTOM_OPTION_MMP_ATTRIBUTABLE,\ \ SKAN_CUSTOM_OPTION_BI_ATTRIBUTABLE, SKAN_CUSTOM_OPTION_SKAN_ATTRIBUTABLE.\n - TARGET_SKADN_ONLY: Target only SKAdNetwork\ \ traffic.\nIt includes SKAN_CUSTOM_OPTION_SKAN_ATTRIBUTABLE.\n - TARGET_NON_SKADN_ONLY: Target only non-SKAdNetwork\ \ traffic.\nIt includes SKAN_CUSTOM_OPTION_MMP_ATTRIBUTABLE, SKAN_CUSTOM_OPTION_BI_ATTRIBUTABLE.\n - TARGET_CUSTOM:\ \ Target customized configuration traffic.\nWhen the targeting_state is set with this value, then custon_options should\ \ be also set." TargetFuturePreferenceInfoCustomProducts: type: object properties: product_ids: type: array items: type: string description: CustomProducts stores Products' ids of which the target prefers. TargetFuturePreferenceInfoProductScope: type: string enum: - UNKNOWN - ALL - ANDROID - IOS default: UNKNOWN description: ProductScope indicates the scope of Product of which the target prefers. TrackingLinkUrlData: type: object properties: url: type: string description: URL of the TrackingLink. status: $ref: '#/components/schemas/TrackingLinkUrlDataVerificationStatus' description: 'The verification status of the supplied URL. It''s managed by the Moloco servers and is readonly to the client.' readOnly: true unverified_status_data: $ref: '#/components/schemas/UrlDataUnverifiedStatusData' verifying_status_data: $ref: '#/components/schemas/UrlDataVerifyingStatusData' verified_status_data: $ref: '#/components/schemas/UrlDataVerifiedStatusData' required: - url TrackingLinkUrlDataVerificationStatus: type: string enum: - UNKNOWN_VERIFICATION_STATUS - UNVERIFIED - VERIFYING - VERIFIED default: UNKNOWN_VERIFICATION_STATUS description: "Enumeration of various TrackingLink verification status.\n\nThis value is not part of the specification.\n\ \n - UNVERIFIED: The TrackingLink is not yet verified.\n - VERIFYING: The TrackingLink is being verified.\n - VERIFIED:\ \ The TrackingLink has been verified." TrackingLinkValidationErrorErrorCode: type: string enum: - UNKNOWN_VALIDATION_ERROR - INVALID_LINK - INVALID_SCHEME - INVALID_HOST - INVALID_PATH - INVALID_QUERY_PARAM - MISSING_REQUIRED_QUERY_PARAM - NOT_ALLOWED_QUERY_PARAM - INVALID_QUERY_PARAM_ENCODED_MACRO - DUPLICATE_QUERY_PARAM - NOT_SUPPORTED_MACRO - CONTAINS_LEGACY_MACRO - ADJUST_BRANDED_LINK_HOST_MISMATCH - ADJUST_UNIVERSAL_LINK_HOST_MISMATCH - AF_TRACKING_BUNDLE_MISMATCH - ADJUST_UNSEEN_TRACKER_TOKEN - ADJUST_CT_VT_TOKEN_MISMATCH - ADJUST_MISSING_BRANDED_LINK_HOST - ADJUST_MISSING_UNIVERSAL_LINK_HOST - ADJUST_CTV_MULTI_TOKEN - AF_AGENCY_TOKEN_MISMATCH - EMPTY_AF_AGENCY_TOKEN - EMPTY_AF_SITEID default: UNKNOWN_VALIDATION_ERROR description: "Specific code for validation error.\n\n - INVALID_LINK: Link cannot be parsed.\n - INVALID_SCHEME: Link\ \ used 'http' instead of 'https'.\n - INVALID_HOST: Link's tracking company doesn't match the TrackingLink.TrackingCompany.\n\ \ - INVALID_PATH: Link's path doesn't match the selected app.\n - INVALID_QUERY_PARAM: Link has an invalid query parameter.\n\ \ - MISSING_REQUIRED_QUERY_PARAM: Link missed required query parameter(s).\n - NOT_ALLOWED_QUERY_PARAM: Link contains\ \ not allowed query parameter(s).\n - INVALID_QUERY_PARAM_ENCODED_MACRO: Link contains invalid encoded macro in query\ \ parameter.\n - DUPLICATE_QUERY_PARAM: Link contains duplicate query parameter.\n - NOT_SUPPORTED_MACRO: Unsupported\ \ macro is used in the link.\n - CONTAINS_LEGACY_MACRO: Link contains legacy macro.\n - ADJUST_BRANDED_LINK_HOST_MISMATCH:\ \ Adjust's BrandedLink host does not match with the one stored in MMP integration.\n - ADJUST_UNIVERSAL_LINK_HOST_MISMATCH:\ \ Adjust's UniversalLink host does not match with the one stored in MMP integration.\n - AF_TRACKING_BUNDLE_MISMATCH:\ \ AppsFlyer's tracking bundle does not match with the one stored in the product.\n - ADJUST_UNSEEN_TRACKER_TOKEN:\ \ Adjust's tracker token does not exist in the ones stored in MMP integration.\n - ADJUST_CT_VT_TOKEN_MISMATCH: Adjust\ \ normal link's click through and view through urls have mismatching tracker tokens.\n - ADJUST_MISSING_BRANDED_LINK_HOST:\ \ Adjust's BrandedLink host name is not set to MMP integration.\n - ADJUST_MISSING_UNIVERSAL_LINK_HOST: Adjust's UniversalLink\ \ host name is not set to MMP integration.\n - ADJUST_CTV_MULTI_TOKEN: Adjust tracking link has multiple tracker tokens.\n\ \ - AF_AGENCY_TOKEN_MISMATCH: AppsFlyer's af_prt value mismatch.\n - EMPTY_AF_AGENCY_TOKEN: AppsFlyer's af_prt value\ \ is empty.\n - EMPTY_AF_SITEID: AppsFlyer's af_siteid value is empty." TrackingLinkVerificationAttemptUrlDataType: type: string enum: - UNKNOWN_URL_DATA_TYPE - CT_LINK - VT_LINK default: UNKNOWN_URL_DATA_TYPE description: The type of the UrlData that this attempt belongs to. UrlDataUnverifiedStatusData: type: object properties: stored_at: type: string format: date-time description: Creation time of this link. user_id: type: string description: The ID of the user who created this link. description: 'UnverifiedStatusData represents the information that the link is statically checked, but has not been verified with the MMP integration.' UrlDataVerifiedStatusData: type: object properties: verified_attempt: $ref: '#/components/schemas/dspTrackingLinkVerificationAttempt' description: The attempt that has verified the link. description: VerifiedStatusData represents the information of the completed verification. UrlDataVerifyingStatusData: type: object properties: attempt_ids: type: array items: type: string description: Each of ID refers to a TrackingLinkVerificationAttempt. description: 'VerifyingStatusData represents the information that a resolved URL has been sent to the MMP, but we have not received any postback yet. We stay at this state indefinitely until receiving a postback.' ValidateTrackingLinkResponseTrackingLinkValidationError: type: object properties: error_code: $ref: '#/components/schemas/TrackingLinkValidationErrorErrorCode' params: type: object additionalProperties: type: string description: 'Params are used to make error message. This value is internal to AdCloud and used for the troubleshooting or reference purpose.' context: type: string description: 'The context is a field name which the error occurred in. It used only in INVALID_QUERY_PARAM error.' error_msg: type: string description: The description for the validation error. adcloudcommonCreativeFeatureType: type: string enum: - UNKNOWN_CREATIVE_FEATURE_TYPE - GENERAL - DYNAMIC_CREATIVE default: UNKNOWN_CREATIVE_FEATURE_TYPE description: CreativeFeatureType. adcloudcommonCreativeType: type: string enum: - UNKNOWN_CREATIVE_TYPE - IMAGE_BANNER - IMAGE_INTERSTITIAL - VIDEO_BANNER - VIDEO_INTERSTITIAL - NATIVE_LOGO - NATIVE_VIDEO - NATIVE_IMAGE - CUSTOM_HTML_BANNER - CUSTOM_HTML_INTERSTITIAL - TEMPLATE_HTML_BANNER - TEMPLATE_HTML_INTERSTITIAL - RICH_CUSTOM_HTML_BANNER - RICH_CUSTOM_HTML_INTERSTITIAL - DYNAMIC_HTML_BANNER - DYNAMIC_HTML_INTERSTITIAL default: UNKNOWN_CREATIVE_TYPE description: 'Enumeration of creative types supported by Moloco Ads. This value is not part of the specification.' adcloudcommonCurrency: type: string enum: - UNKNOWN_CURRENCY - USD - KRW - JPY - EUR - GBP default: UNKNOWN_CURRENCY description: "Enumeration of currencies supported by Moloco Ads.\n\nThis value is not part of the specification.\n\n\ \ - USD: US Dollar.\n - KRW: Korean Won.\n - JPY: Japanese Yen.\n - EUR: EU Euro.\n - GBP: British Pound." adcloudcommonDateInterval: type: object properties: start: type: string description: Start date in the format of YYYY-MM-DD. end: type: string description: End date in the format of YYYY-MM-DD. description: Interval with start and end dates in the format of YYYY-MM-DD. adcloudcommonDayOfWeek: type: string enum: - UNKNOWN_DAY_OF_WEEK - MON - TUE - WED - THU - FRI - SAT - SUN default: UNKNOWN_DAY_OF_WEEK description: 'Enumeration for week days. This value is not part of the specification.' adcloudcommonEventType: type: string enum: - UNKNOWN_EVENT_TYPE - BID_MADE - BID_WON - IMPRESSION - IMPRESSION_EXTRA - CLICK - INSTALL - CUSTOM default: UNKNOWN_EVENT_TYPE description: "Enumeration of event types supported by Moloco Ads.\n\nThis value is not part of the specification.\n\n\ \ - BID_MADE: A bid has been made for a bid request.\n - BID_WON: The bid has won the auction.\n - IMPRESSION: The\ \ ad impression has been served to the user.\n - IMPRESSION_EXTRA: Extra ad impression tracking info, e.g. 50% of\ \ a video ad has been shown.\n - CLICK: The ad has been clicked by the user.\n - INSTALL: The ad impression or click\ \ has been attributed with an app install.\n - CUSTOM: Custom actions that happen after install." adcloudcommonFloatingPointRange: type: object properties: start: type: number format: double end: type: number format: double adcloudcommonInterval: type: object properties: start: type: integer format: int32 end: type: integer format: int32 description: Interval represents a contiguous integer range [start, end). adcloudcommonMoney: type: object properties: currency: $ref: '#/components/schemas/adcloudcommonCurrency' amount_micros: type: string format: int64 description: 'Represents a monetary amount in micros for a specified currency. It''s the amount in the specified currency''s base denomination unit multiplied with 1 million. Both currency and amount are required.' adcloudcommonTimezonePolicy: type: string enum: - UNKNOWN_TIME - DEVICE_TIME - UTC_TIME - AD_ACCOUNT_TIME - ADVERTISER_TIME default: UNKNOWN_TIME description: "TimezonePolicy defines the time configuration.\n\n - DEVICE_TIME: Time object is given in the device's\ \ time (depends on user device timezone).\n - UTC_TIME: Time object is given in the fixed UTC time (depends on nothing).\n\ \ - AD_ACCOUNT_TIME: Given time is given in fixed ad account time (depends on ad account timezone)." adcloudcommonTrackingCompany: type: string enum: - UNKNOWN_TRACKING_COMPANY - KOCHAVA - ADJUST - MAT - MOLOCO_PIXEL - APPSFLYER - ADBRIX - WEB - GENERIC - TRACKFNT - AIRBRIDGE - MOLOCO_E2E - APSALAR - BRANCH - TENJIN - SINGULAR - ADBRIX_V2 - TRAFFICGUARD - GAMELOFT - SKADNETWORK - MYTRACKER - MOLOCO_RMP - MOLOCO_PIXEL_V2 - JUSTTRACK - SHOPEE - KOCHAVA_FOR_PUBLISHER - GAMESIGHT - CAULY - HASOFFER - ADACTION - CURATE default: UNKNOWN_TRACKING_COMPANY description: "Enumeration for tracking companies supported by Moloco Ads.\n\n - WEB: Unnamed trackers\n - AIRBRIDGE:\ \ Moloco's e2e tracker (test purpose only)\n - KOCHAVA_FOR_PUBLISHER: Kochava's CTV to web event dedicated tracking\ \ company." adclouddspAdCapper: type: object properties: imp_interval: $ref: '#/components/schemas/commonTimeDuration' description: 'Cooling time interval between impressions to a user. If not specified, the API set the default value of 1 hour.' description: AdCapper represents capping settings for an AdGroup. adclouddspAudience: type: object properties: shared_audience_target_ids: type: array items: type: string description: A list of IDs for the named AudienceTargets referenced by this audience specification. targeting_condition: $ref: '#/components/schemas/dspAudienceTargetingCondition' description: Ad-hoc AudienceTargeting condition constructed for this audience specification only. description: 'Audience is a final form of AudienceTargeting specification. It is represented by a list of IDs of SharedAudienceTargets and an ad-hoc target condition. All conditions in the audience specification must be met to accept a bid-request. IDs of the SharedAudienceTargets can be either at global or AdAccount level.' commonAdExchange: type: string enum: - UNKNOWN_AD_EXCHANGE - MOPUB - ADX - ADMIXER - SMAATO - RUBICON - EXELBID - BRIGHTROLL - CAULYRTB - ADLIB - ORION - MOLOCO - ADOP - APPLOVIN - FYBER - SAMSUNG - ADCOLONY - POLYMORPH - CHARTBOOST - MANPLUS - KAKAO - UNITY - FYBERCORE - ADGENERATION - SAMSUNGPAY - NHN - ADPOPCORN - OPENX - VUNGLE - ADALPHA - BYTEDANCE - NAVER - INMOBI - SIGNALPLAY - ACUITY - IRONSOURCE - PUBMATIC - BAIDU - FLUCT - FIVE - APPODEAL - ADPIE - MOBILITYWARE - TPMN - PUBNATIVE - TAPJOY - MOMENTO - BIDENCE - APS - INDEX - IQZONE - STARTIO - FLOWER - ONESTORE - NIMBUS - AEQUUS - MCTV - MINTEGRAL - MOLOCO_SDK_APPLOVIN - MOLOCO_SDK_IRONSOURCE - PANGLE - MAGNITE - MOLOCO_SDK_X3MADS - FREE_WHEEL - MOLOCO_SDK_ADMOB - ADX_RTB - XIAOMI - MOLOCO_SDK_CREATIVE_TEST - MOLOCO_SDK_MAX - MOLOCO_SDK_LEVELPLAY - NEXXEN - MOLOCO_SDK_ADMOB_MEDIATION - MOLOCO_SDK - MOLOCO_SDK_IN_HOUSE_MEDIATION - TABOOLA - CRITEO - MOLOCO_SDK_DIRECT_AD - APX1 - DIRECT_AD - BIGO - CAS - TUBI default: UNKNOWN_AD_EXCHANGE description: "Enumeration of ad exchanges supported by Moloco Ads.\n\n - SIGNALPLAY: MANPLUS == SIGNALPLAY. just added\ \ for distinguishing video and banner report\n - MOLOCO_SDK: Used for a consolidated MOLOCO SDK exchange.\n - APX1:\ \ APX1 is LINE's anonymized exchange name (renamed from LINE - no production traffic, direct replacement)" commonAdvertiserIdType: type: string enum: - UNKNOWN_ADVERTISER_ID_TYPE - ANDROID_IDFA - IOS_IDFA - GENERIC_USER_ID - GENERIC_DEVICE_ID - ANDROID_LAT_IDFA - IOS_LAT_IDFA default: UNKNOWN_ADVERTISER_ID_TYPE description: "Enumeration of supported ID types for advertises.\n\nThis value is not part of the specification.\n\n\ \ - ANDROID_IDFA: IDFA used in Android.\n - IOS_IDFA: IDFA used in iOS.\n - GENERIC_USER_ID: This is used when IDFA\ \ is unavailable and an alternative user id is available.\nFor example, Google's adid is used for mobile web inventories.\n\ \ - GENERIC_DEVICE_ID: This is used when IDFA is unavailable and an alternative device id is available.\nFor example,\ \ Mopub sends out device id in some apps.\n - ANDROID_LAT_IDFA: infra-generating IDFA used for Android LAT devices\n\ \ - IOS_LAT_IDFA: infra-generating IDFA used for iOS LAT devices" commonAssetKind: type: string enum: - UNKNOWN_ASSET_KIND - CREATIVE - CSV - ASSET_DYNAMIC_CREATIVE - FB_PLAYABLE_AD default: UNKNOWN_ASSET_KIND description: "List of asset kinds supported by Moloco Ads.\n\n - UNKNOWN_ASSET_KIND: This value is not part of the specification.\n\ \ - CREATIVE: Creative asset type.\n - CSV: text/csv type.\n - ASSET_DYNAMIC_CREATIVE: Asset for Dynamic Creatives.\n\ \ - FB_PLAYABLE_AD: Facebook Playable AD." commonAudienceData: type: object properties: provider: type: string title: Data provider's unique name condition: type: string title: 'SQL like condition statement for filtering powered by qlbridge library. Ref. https://github.com/araddon/qlbridge' description: Audience Data. It is a filter based on AudienceData stored in UPT. commonBannerApi: type: string enum: - UNKNOWN_BANNER_API - MRAID_2 default: UNKNOWN_BANNER_API title: Banner API commonCircle: type: object properties: center: $ref: '#/components/schemas/commonLatLng' radius: type: number format: double description: Circle defines a circle with a center geo location and radius in km. commonDeviceOs: type: string enum: - UNKNOWN_DEVICE_OS - ANDROID - IOS - VERSATILE - MOBILE_WEB - MACOS - WINDOWS - NEXT_VERSATILE default: UNKNOWN_DEVICE_OS description: "Enumeration of device OS types supported by Moloco Ads.\n\nThis value is not part of the specification.\n\ \n - ANDROID: Android device OS.\n - IOS: iOS device OS.\n - VERSATILE: Product with multiple OSes.\nSpecifically\ \ for CTV.\n - MOBILE_WEB: OS for mobile web traffic.\n - MACOS: OS for MacOS traffic.\n - WINDOWS: OS for Windows\ \ traffic.\n - NEXT_VERSATILE: OS for Next web product." commonDeviceType: type: string enum: - UNKNOWN_DEVICE_TYPE - MOBILE - PERSONAL_COMPUTER - CONNECTED_TV - HIGHEND_PHONE - TABLET - CONNECTED_DEVICE - SET_TOP_BOX default: UNKNOWN_DEVICE_TYPE description: 'Enumeration of device types supported by Moloco Ads. This value is not part of the specification.' commonDisplayManagerVersion: type: object properties: min: type: string max: type: string description: Display Manager Version. commonEnablingState: type: string enum: - UNSPECIFIED - ENABLED - DISABLED default: UNSPECIFIED description: Enumeration of the enabling states with a default UNSPECIFIED state. commonEntityType: type: string enum: - UNKNOWN_ENTITY_TYPE - ENTITY_TYPE_PLATFORM - ENTITY_TYPE_AD_ACCOUNT - ENTITY_TYPE_PRODUCT - ENTITY_TYPE_CAMPAIGN - ENTITY_TYPE_AD_GROUP - ENTITY_TYPE_CREATIVE_GROUP - ENTITY_TYPE_CREATIVE - ENTITY_TYPE_TRACKING_LINK - ENTITY_TYPE_TARGET - ENTITY_TYPE_CUSTOMER_SET - ENTITY_TYPE_CUSTOMER_ACTIVITY default: UNKNOWN_ENTITY_TYPE description: List of entity types supported in DSP API. commonGender: type: string enum: - UNKNOWN_GENDER - FEMALE - MALE default: UNKNOWN_GENDER description: 'Enumeration of gender types. This value is not part of the specification.' commonLatLng: type: object properties: latitude: type: number format: double longitude: type: number format: double description: Point defines a geo location by latitude, longitude. commonLaunchNotice: type: object properties: type: $ref: '#/components/schemas/LaunchNoticeNoticeType' description: The type of the notice. message: $ref: '#/components/schemas/LaunchNoticeNoticeMessage' description: The message for the notice. description: LaunchNotice contains notice information to be confirmed when launching a campaign. commonLocale: type: string enum: - UNKNOWN_LOCALE - EN_US - KO_KR - JA_JP default: UNKNOWN_LOCALE description: "Locale enumerates the supported user locale values.\n\n - EN_US: English (United States)\n - KO_KR: Korean\ \ (South Korea)\n - JA_JP: Japanese (Japan)" commonPostbackEventCount: type: object properties: app_bundle: type: string range: $ref: '#/components/schemas/adcloudcommonInterval' events: type: array items: type: string description: Postback Event Count. It specifies an interval for a list of events from an app bundle. commonPostbackEventsCondition: type: object properties: audiences: type: array items: type: string description: Audience name. i.e. app bundle. events: type: array items: type: string description: List of events such as install and purchase. past_time_range: $ref: '#/components/schemas/adcloudcommonInterval' description: Past time range for a postback event. past_time_range_unit: $ref: '#/components/schemas/commonTimeUnit' description: 'The unit for past_time_range. In PostbackEventsCondition, only DAY and MINUTE are used.' range: $ref: '#/components/schemas/commonTimeInterval' description: Range for a postback event. short_term_user_profile: type: boolean description: If set, short-term user profile information is used to evaluate this condition. count_range: $ref: '#/components/schemas/adcloudcommonInterval' description: Accepted range of event count. description: Postback Events Condition. commonTagsThrottleCondition: type: object properties: tags: type: array items: type: string throttle_rate: type: number format: float description: 'Tags Thrrottle Condition. It specifies a throttle rate for a list of tags. All the tags in a list will have same throttle rate.' commonTimeDuration: type: object properties: amount: type: string format: int64 unit: $ref: '#/components/schemas/commonTimeUnit' description: Represents a time duration with an amount and a unit. commonTimeInterval: type: object properties: start: type: string format: date-time description: Start time in RFC3339 format, e.g. "2017-04-01T12:34:56+00:00". end: type: string format: date-time description: End time in RFC3339 format, e.g. "2017-05-01-T21:09:08+00:00". description: Interval with start and end timestamps in RFC3339 format. commonTimeUnit: type: string enum: - UNKNOWN_TIME_UNIT - MINUTE - HOUR - DAY - WEEK default: UNKNOWN_TIME_UNIT description: 'A unit of time, e.g. second, minute, etc. This value is not part of the specification.' dspAdAccount: type: object properties: id: type: string description: Unique identifier of the AdAccount. Automatically set by server on creation. title: type: string description: A descriptive name of the AdAccount. description: type: string description: An optional description of the AdAccount. timezone: type: string description: '[IANA timezone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) name. e.g. America/Los_Angeles.' currency: $ref: '#/components/schemas/adcloudcommonCurrency' custom_key_values: type: object additionalProperties: type: string description: 'Custom key/values managed by the Moloco Ads client platform. It''s up to the client ads platform to define the schema for the values and their optionality. The keys are recommended, but not required, to be prefixed with the reversed internet domain of the AdCloud client platform company. For example, keys defined by the client ads platform company "example.com" should have "com.example." as the prefix. For complex values, JSON payload is recommended. Moloco doesn''t interpret these data in any way for ads serving. Upon serving, the custom key/values in the AdAccount, Campaign, and Creative models will be combined into the serving Creative proto in the order of precedence, with Creative''s value having the highest precedence on the same key.' billing_account_id: type: string description: BillingAccount to be applied by default. created_at: type: string format: date-time description: Created time. readOnly: true updated_at: type: string format: date-time description: Last updated time. Should not modify on the client side. targets_future_preferences: type: object additionalProperties: $ref: '#/components/schemas/AdAccountTargetFuturePreferenceInfo' description: targets_future_preferences maps each target_id to corresponding TargetFuturePreferenceInfo. description: 'AdAccount represents a person or organization who owns Products and aims to promote the Products with advertising Campaigns.' required: - title dspAdGroup: type: object properties: id: type: string description: Unique identifier of the AdGroup. Automatically set by server on creation. title: type: string description: A descriptive name of the AdGroup. campaign_id: type: string description: ID of the Campaign the AdGroup belongs to. readOnly: true product_id: type: string description: ID of the Product the AdGroup belongs to. readOnly: true ad_account_id: type: string description: ID of the AdAccount the AdGroup belongs to. readOnly: true experiment_id: type: string description: ID of the Experiment the AdGroup is involved in. readOnly: true enabling_state: $ref: '#/components/schemas/commonEnablingState' description: 'Whether this AdGroup is enabled. If the value of this field is unset or set to UNSPECIFIED in the AdGroup creation request, it will be set to ENABLED by default by the server. An active AdGroup can be paused any time by setting this field to DISABLED.' audience: $ref: '#/components/schemas/adclouddspAudience' description: If specified, audience describes AdGroup-level targeting conditions. capper: $ref: '#/components/schemas/adclouddspAdCapper' description: AdGroup wide capper. pricing_model_id: type: string description: PricingModel id. readOnly: true creative_group_ids: type: array items: type: string description: 'CreativeGroup IDs. These CreativeGroups'' Product IDs must match the Product ID of the current Campaign. A Campaign eligible for serving must have at least one enabled CreativeGroup with enabled Creatives.' user_buckets: type: array items: type: object $ref: '#/components/schemas/adcloudcommonInterval' description: User buckets for traffic control. audience_extension: $ref: '#/components/schemas/dspAdGroupAudienceExtension' description: AudienceExtension settings for AdGroup. created_at: type: string format: date-time description: Created time. readOnly: true updated_at: type: string format: date-time description: Last updated time. Should not modify on the client side. aud_size: type: string format: int64 description: Original audience size information. readOnly: true matchable_aud_size: type: string format: int64 description: Matchable audience size information. readOnly: true last_aud_size_computed_at: type: string format: date-time description: Last updated time of the audience size information. readOnly: true description: AdGroup represents the seed information for a full AdGroup used by bidders. required: - title dspAdGroupAudienceExtension: type: object properties: paired_ad_group_id: type: string description: Audience extension paired ad group id. is_secondary: type: boolean description: True for the secondary ad_group, otherwise false. description: AdGroupAudienceExtension holds the ad_group settings for PAS audience extension. readOnly: true dspAdGroupOverview: type: object properties: ad_group: $ref: '#/components/schemas/dspAdGroup' description: The retrieved AdGroup. campaign_id: type: string description: ID of the Campaign. campaign_title: type: string description: Title of the Campaign. campaign_description: type: string description: Description of the Campaign. campaign_state: $ref: '#/components/schemas/dspCampaignState' description: State of the Campaign. campaign_type: $ref: '#/components/schemas/dspCampaignType' description: Type of the Campaign. campaign_goal: $ref: '#/components/schemas/dspCampaignGoal' description: Goal of the Campaign. campaign_countries: type: array items: type: string description: The countries of the Campaign. campaign_schedule: $ref: '#/components/schemas/commonTimeInterval' description: Schedule of the Campaign. campaign_auto_delete_at: type: string format: date-time description: Auto delete timestamp of the Campaign. readOnly: true product_id: type: string description: ID of the Product. product_title: type: string description: Title of the Product. description: AdGroupOverview is an overview information of AdGroup entity. dspAdTrackingAllowance: type: string enum: - UNKNOWN_AD_TRACKING_ALLOWANCE - NON_LAT_ONLY - LAT_ONLY - DO_NOT_CARE default: UNKNOWN_AD_TRACKING_ALLOWANCE description: "AdTrackingAllowance represents targeting conditions regarding\npersonalized ad tracking.\n\nThis value\ \ is not part of the specification.\n\n - NON_LAT_ONLY: Campaign will bid only to the traffic with IDFA as usual Campaigns.\n\ \ - LAT_ONLY: Campaign will bid only to the traffic without IDFA. Limited Ad Tracking only.\n - DO_NOT_CARE: Campaign\ \ will not care whether it has an IDFA or not. Default as of now." dspAdvertiserInfo: type: object properties: id: type: string description: Unique ID of the advertiser. title: type: string description: A descriptive name of the advertiser. description: type: string description: A description of the advertiser. description: 'AdvertiserInfo contains some basic information about an advertiser. It may be returned to Creative reviewers or other users with other non-advertiser roles to perform their duty without leaking any private advertiser information.' dspAnalyticsDetailAdAccountColumn: type: object properties: id: type: string description: Unique ID of an ad-account. title: type: string description: Descriptive name of an ad-account. currency: $ref: '#/components/schemas/adcloudcommonCurrency' description: Contract currency in ISO-4217. description: AdAccountColumn represents a structured column containing ad-account information. dspAnalyticsDetailAdGroupColumn: type: object properties: id: type: string description: Unique ID of an ad-group. title: type: string description: Descriptive name of an ad-group. description: AdGroupColumn represents a structured column containing ad-group information. dspAnalyticsDetailAppColumn: type: object properties: id: type: string description: Unique ID of an App. title: type: string description: Descriptive name of an App. store_id: type: string description: Store ID of an App. os: $ref: '#/components/schemas/commonDeviceOs' description: OS type of an App. description: AppColumn represents a structured column containing app information. dspAnalyticsDetailCampaignColumn: type: object properties: id: type: string description: Unique ID of a campaign. title: type: string description: Descriptive name of a campaign. type: type: string description: Type of a campaign. target_countries: type: array items: type: string description: Target country code list in ISO-3166 Alpha-3. bid_country: type: string description: Bid country code in ISO-3166 Alpha-3. country: type: string description: Representative target country code in ISO-3166 Alpha-3. goal_type: type: string description: Goal Type of a campaign. is_cross_promo: type: boolean description: Flag indicating whether the campaign is cross promo campaign. description: CampaignColumn represents a structured column containing campaign information. dspAnalyticsDetailConversionEventColumn: type: object properties: name: type: string description: The name of the conversion event. count: type: string format: int64 description: The total number of the conversion event. revenue: type: number format: double description: The total revenue of the conversion event. description: ConversionEventColumn represents a structured column containing conversion event name and metrics for the current row. dspAnalyticsDetailConversionEventFilter: type: object properties: operator: $ref: '#/components/schemas/dspAnalyticsDetailDimensionFilterOperator' description: Operator for the conversion event filter. values: type: array items: type: string description: Values to filter by the conversion event. description: AnalyticsDetailConversionEventFilter specifies a filter for the detailed analytics conversion events. dspAnalyticsDetailConversionEventMetricFilter: type: object properties: conversion_event: type: string description: ConversionEvent to filter on. count_condition: $ref: '#/components/schemas/dspAnalyticsDetailConversionEventMetricFilterCondition' description: Filter condition for the total number of the conversion event. description: AnalyticsDetailConversionEventMetricFilter specifies a filter for the detailed analytics conversion event metrics. dspAnalyticsDetailConversionEventMetricFilterCondition: type: object properties: operator: $ref: '#/components/schemas/dspAnalyticsDetailMetricFilterOperator' description: Operator for the conversion event metric filter. value: type: string description: Value to filter by the conversion event metric. description: Condition for the conversion event metrics. dspAnalyticsDetailCreativeColumn: type: object properties: id: type: string description: Unique ID of a creative. title: type: string description: Descriptive name of a creative. type: type: string description: Type of a creative. main_asset_location: type: string description: URL of the main asset of a creative. format: type: string title: Size of creatives (e.g. 1080x1920, HTML, etc) video_duration_seconds: type: integer format: int32 description: Total duration(Seconds) of the Video creatives. video_end_card_type: type: string description: Type of the end card of the Video creatives. is_dca: type: boolean description: Flag indicating whether the creative is a DCA (Dynamic Creative Assembly) creative. description: CreativeColumn represents a structured column containing creative information. dspAnalyticsDetailCreativeGroupColumn: type: object properties: id: type: string description: Unique ID of a creative-group. title: type: string description: Descriptive name of a creative-group. is_dca: type: boolean description: Flag indicating whether the creative-group is a DCA (Dynamic Creative Assembly) creative-group. description: CreativeGroupColumn represents a structured column containing creative-group information. dspAnalyticsDetailDeviceColumn: type: object description: DeviceColumn represents a structured column containing device information. dspAnalyticsDetailDimension: type: string enum: - UNKNOWN_DIMENSION - DATE - HOUR - TIMEZONE - AD_ACCOUNT_ID - AD_ACCOUNT_TITLE - AD_ACCOUNT_CURRENCY - APP_OR_SITE_ID - APP_OR_SITE_TITLE - APP_TYPE - APP_OS - APP_STORE_ID - SITE_DOMAIN - CAMPAIGN_ID - CAMPAIGN_TITLE - CAMPAIGN_TYPE - CAMPAIGN_TARGET_COUNTRIES - CAMPAIGN_BID_COUNTRY - CAMPAIGN_COUNTRY - CAMPAIGN_GOAL_TYPE - AD_GROUP_ID - AD_GROUP_TITLE - CREATIVE_GROUP_ID - CREATIVE_GROUP_TITLE - CREATIVE_GROUP_IS_DCA - CREATIVE_ID - CREATIVE_TITLE - CREATIVE_TYPE - CREATIVE_MAIN_ASSET_LOCATION - CREATIVE_FORMAT - CREATIVE_VIDEO_DURATION_SECONDS - CREATIVE_VIDEO_END_CARD_TYPE - CREATIVE_IS_DCA - EXCHANGE_ID - SUB_PUBLISHER_ID - SUB_PUBLISHER_TITLE - INVENTORY_TYPE - TRAFFIC_LAT default: UNKNOWN_DIMENSION description: "Dimension enumerates available dimensions.\n\n - UNKNOWN_DIMENSION: This value is not part of the API\ \ specification.\n - AD_ACCOUNT_ID: AD_ACCOUNT\n - APP_OR_SITE_ID: APP_OR_SITE\n - CAMPAIGN_ID: CAMPAIGN\n - AD_GROUP_ID:\ \ AD_GROUP\n - CREATIVE_GROUP_ID: CREATIVE_GROUP\n - CREATIVE_ID: CREATIVE\n - EXCHANGE_ID: EXCHANGE\n - INVENTORY_TYPE:\ \ INVENTORY\n - TRAFFIC_LAT: TRAFFIC" dspAnalyticsDetailDimensionFilter: type: object properties: dimension: $ref: '#/components/schemas/dspAnalyticsDetailDimension' description: Dimension to filter on. operator: $ref: '#/components/schemas/dspAnalyticsDetailDimensionFilterOperator' values: type: array items: type: string description: Values to filter by the dimension. description: AnalyticsDetailDimensionFilter specifies a filter for the detailed analytics dimensions. dspAnalyticsDetailDimensionFilterOperator: type: string enum: - UNKNOWN_DIMENSION_OPERATOR - IN - NOT_IN default: UNKNOWN_DIMENSION_OPERATOR description: Operator for the dimension filter. dspAnalyticsDetailExchangeColumn: type: object properties: id: type: string description: Unique ID of an exchange. description: ExchangeColumn represents a structured column containing exchange information. dspAnalyticsDetailInventoryColumn: type: object properties: type: type: string description: Type of an ad slot inventory. description: InventoryColumn represents a structured column containing inventory information. dspAnalyticsDetailJob: type: object properties: id: type: string description: The ID of the job. description: The job information executed for the detailed analytics query request. dspAnalyticsDetailMetric: type: string enum: - UNKNOWN_METRIC - IMPRESSIONS - ENGAGED_VIEWS - CLICKS - INSTALLS - INSTALLS_CT - CONVERSIONS - TARGET_ACTIONS - SPEND - REVENUE - CTR - IPM - CPC - CPI - CPA - CPCONV - VTR - CPCV - CPS - CPPV - PVPI - VIDEO_PLAY_1Q - VIDEO_PLAY_2Q - VIDEO_PLAY_3Q - VIDEO_PLAY_4Q - PAGE_VISITS - SESSIONS - DRIVEN_INSTALLS - MOLOCO_MEASURED_INSTALLS - MOLOCO_MEASURED_EQUAL_PRIORITY_WINDOW_INSTALLS - UNIQUE_VISITORS - UNIQUE_PURCHASERS - CPUV - CPUP - PAGE_VISITS_1D - PAGE_VISITS_3D - PAGE_VISITS_7D - PAGE_VISITS_14D default: UNKNOWN_METRIC description: "Metric enumerates available metrics.\n\n - UNKNOWN_METRIC: This value is not part of the API specification.\n\ \ - IMPRESSIONS: DEFAULT METRICS\n - CTR: RATIO METRICS\n - CPS: CTV RATIO METRICS\n - VIDEO_PLAY_1Q: VIDEO METRICS\n\ \ - PAGE_VISITS: CTV METRICS\n - PAGE_VISITS_1D: The total number of page visits within 1 day of the corresponding\ \ impression.\n - PAGE_VISITS_3D: The total number of page visits within 3 days of the corresponding impression.\n\ \ - PAGE_VISITS_7D: The total number of page visits within 7 days of the corresponding impression.\n - PAGE_VISITS_14D:\ \ The total number of page visits within 14 days of the corresponding impression." dspAnalyticsDetailMetricColumn: type: object properties: impressions: type: string format: int64 description: The total number of impressions. engaged_views: type: string format: int64 description: The total number of engaged views. engaged_clicks: type: string format: int64 description: The total number of engaged clicks. clicks: type: string format: int64 description: The total number of clicks. installs: type: string format: int64 description: The total number of installs. installs_ct: type: string format: int64 description: The total number of click-through installs. conversions: type: string format: int64 description: The total number of conversions selected by a user. target_actions: type: string format: int64 description: The total number of CPA Campaign's target actions. spend: type: number format: double description: The total ads spending for the current row. revenue: type: number format: double description: The total revenue for the current row. ctr: type: number format: double description: The total ads CTR for the current row. ipm: type: number format: double description: The total ads IPM for the current row. cpc: type: number format: double description: The total ads CPC for the current row. cpi: type: number format: double description: The total ads CPI for the current row. cpa: type: number format: double description: The total ads CPA for the current row. cpconv: type: number format: double description: The total ads CPConv for the current row. vtr: type: number format: double description: The total VTR for the current row. cpcv: type: number format: double description: The total ads CPCV for the current row. cps: type: number format: double description: The total ads CPS for the current row. cppv: type: number format: double description: The total ads CPPV for the current row. pvpi: type: number format: double description: The total ads PVPI for the current row. video_play_1q: type: string format: int64 description: 'VideoMetric columns represent video view progress metric numbers. The total number of video play for 1st quarter.' video_play_2q: type: string format: int64 description: The total number of video play for 2nd quarter. video_play_3q: type: string format: int64 description: The total number of video play for 3rd quarter. video_play_4q: type: string format: int64 description: The total number of video play for 4th quarter. page_visits: type: string format: int64 title: Page visits sessions: type: string format: int64 title: Sessions driven_installs: type: string format: int64 moloco_measured_installs: type: string format: int64 moloco_measured_equal_priority_window_installs: type: string format: int64 unique_visitors: type: string format: int64 unique_purchasers: type: string format: int64 cpuv: type: number format: double cpup: type: number format: double page_visits_1d: type: string format: int64 description: The total number of page visits within 1 day of the corresponding impression. page_visits_3d: type: string format: int64 description: The total number of page visits within 3 days of the corresponding impression. page_visits_7d: type: string format: int64 description: The total number of page visits within 7 days of the corresponding impression. page_visits_14d: type: string format: int64 description: The total number of page visits within 14 days of the corresponding impression. description: MetricColumn represents a structured column containing metric numbers. dspAnalyticsDetailMetricFilter: type: object properties: metric: $ref: '#/components/schemas/dspAnalyticsDetailMetric' description: Metric to filter on. operator: $ref: '#/components/schemas/dspAnalyticsDetailMetricFilterOperator' value: type: string description: Value to filter by the metric. description: AnalyticsDetailMetricFilter specifies a filter for the detailed analytics metrics. dspAnalyticsDetailMetricFilterOperator: type: string enum: - UNKNOWN_METRIC_OPERATOR - EQ - GT - GE - LT - LE default: UNKNOWN_METRIC_OPERATOR description: Operator for the metric filter. dspAnalyticsDetailOrderByFilter: type: object properties: dimension: $ref: '#/components/schemas/dspAnalyticsDetailDimension' description: Dimension column to apply order by. metric: $ref: '#/components/schemas/dspAnalyticsDetailMetric' description: Metric column to apply order by. conversion_event: type: string description: ConversionEvent names comes here if order_by should be applied to ConversionEvent column. is_descending: type: boolean description: 'Whether it is descending order. If is_descending is false (which is default), the result will be sorted in ascending order.' description: AnalyticsDetailOrderByFilter specifies a filter for the detailed analytics order by. dspAnalyticsDetailRow: type: object properties: date: type: string description: The date in the local timezone with 'YYYY-MM-DD' format. hour: type: integer format: int32 description: Hour in the local timezone. timezone: type: string description: Timezone. ad_account: $ref: '#/components/schemas/dspAnalyticsDetailAdAccountColumn' description: AdAccount column. app: $ref: '#/components/schemas/dspAnalyticsDetailAppColumn' description: App column. site: $ref: '#/components/schemas/dspAnalyticsDetailSiteColumn' description: Site column. campaign: $ref: '#/components/schemas/dspAnalyticsDetailCampaignColumn' description: Campaign column. ad_group: $ref: '#/components/schemas/dspAnalyticsDetailAdGroupColumn' description: AdGroup column. creative_group: $ref: '#/components/schemas/dspAnalyticsDetailCreativeGroupColumn' description: CreativeGroup column. creative: $ref: '#/components/schemas/dspAnalyticsDetailCreativeColumn' description: Creative column. exchange: $ref: '#/components/schemas/dspAnalyticsDetailExchangeColumn' description: Exchange column. sub_publisher: $ref: '#/components/schemas/dspAnalyticsDetailSubPublisherColumn' description: SubPublisher column. inventory: $ref: '#/components/schemas/dspAnalyticsDetailInventoryColumn' description: Inventory column. traffic: $ref: '#/components/schemas/dspAnalyticsDetailTrafficColumn' description: Traffic column. device: $ref: '#/components/schemas/dspAnalyticsDetailDeviceColumn' description: Device column. metric: $ref: '#/components/schemas/dspAnalyticsDetailMetricColumn' description: Metric column. conversion_events: type: array items: type: object $ref: '#/components/schemas/dspAnalyticsDetailConversionEventColumn' description: List of ConversionEvent column. description: Row defines one row of the detailed analytics query result. dspAnalyticsDetailSiteColumn: type: object properties: id: type: string description: Unique ID of a Site. title: type: string description: Descriptive name of a Site. domain: type: string description: Domain of the site. description: SiteColumn represents a structured column containing site information. dspAnalyticsDetailSubPublisherColumn: type: object properties: type: $ref: '#/components/schemas/dspAnalyticsDetailSubPublisherColumnType' description: Type of a sub-publisher. This will be either App or Site. id: type: string description: "Unique ID of a sub-publisher.\n\nThis ID will be either\n - bid-request.app.bundle\n - bid-request.site.domain" title: type: string description: Descriptive name of a sub-publisher. description: SubPublisherColumn represents a structured column containing sub-publisher information. dspAnalyticsDetailSubPublisherColumnType: type: string enum: - UNKNOWN_TYPE - APP - SITE default: UNKNOWN_TYPE description: ' - UNKNOWN_TYPE: This value is not part of the API specification.' dspAnalyticsDetailTrafficColumn: type: object properties: lat: type: boolean description: Flag indicating whether LAT option is on or not. description: TrafficColumn represents a structured column containing LAT information. dspAnalyticsOverviewAdAccountColumn: type: object properties: id: type: string description: Unique ID of an ad-account. title: type: string description: Descriptive name of an ad-account. currency: $ref: '#/components/schemas/adcloudcommonCurrency' description: Contract currency in ISO-4217. description: AdAccountColumn represents a structured column containing ad-account information. dspAnalyticsOverviewAdGroupColumn: type: object properties: id: type: string description: Unique ID of an AdGroup. title: type: string description: Descriptive name of an AdGroup. description: AdGroupColumn represents a structured column containing AdGroup information. dspAnalyticsOverviewAppColumn: type: object properties: id: type: string description: Unique ID of an App. title: type: string description: Descriptive name of an App. store_id: type: string description: Store ID of an App. os: $ref: '#/components/schemas/commonDeviceOs' description: OS type of an App. description: AppColumn represents a structured column containing app information. dspAnalyticsOverviewCampaignColumn: type: object properties: id: type: string description: Unique ID of a Campaign. title: type: string description: Descriptive name of a Campaign. target_countries: type: array items: type: string description: Target country code list in ISO-3166 Alpha-3. bid_country: type: string description: Bid country code in ISO-3166 Alpha-3. type: type: string description: Type of a Campaign. goal_type: type: string description: Goal Type of a Campaign. is_cross_promo: type: boolean description: Flag indicating whether the Campaign is cross-promotion. description: CampaignColumn represents a structured column containing Campaign information. dspAnalyticsOverviewCreativeColumn: type: object properties: id: type: string description: Unique ID of a creative. title: type: string description: Descriptive name of a creative. type: type: string description: Type of a creative. main_asset_url: type: string description: URL of the main asset of a creative. format: type: string description: Format of a creative. video_duration_seconds: type: integer format: int32 description: Duration of a video creative. video_end_card_type: type: string description: End card type of a video creative. is_dca: type: boolean description: Flag indicating whether the creative is a DCA (Dynamic Creative Assembly) creative. description: CreativeColumn represents a structured column containing creative information. dspAnalyticsOverviewCreativeGroupColumn: type: object properties: id: type: string description: Unique ID of a creative-group. title: type: string description: Descriptive name of a creative-group. is_dca: type: boolean description: Flag indicating whether the creative-group is a DCA (Dynamic Creative Assembly) creative-group. description: CreativeGroupColumn represents a structured column containing creative-group information. dspAnalyticsOverviewDeviceColumn: type: object description: DeviceColumn represents a structured column containing device information. dspAnalyticsOverviewDimension: type: string enum: - UNKNOWN_GROUP_BY - DATE - TIMEZONE - AD_ACCOUNT_ID - AD_ACCOUNT_TITLE - AD_ACCOUNT_CURRENCY - APP_OR_SITE_ID - APP_OR_SITE_TITLE - APP_TYPE - APP_OS - APP_STORE_ID - SITE_DOMAIN - CAMPAIGN_ID - CAMPAIGN_TITLE - CAMPAIGN_TYPE - CAMPAIGN_TARGET_COUNTRIES - CAMPAIGN_BID_COUNTRY - AD_GROUP_ID - AD_GROUP_TITLE - TRAFFIC_LAT - CAMPAIGN_GOAL_TYPE - CREATIVE_GROUP_ID - CREATIVE_GROUP_TITLE - CREATIVE_GROUP_IS_DCA - CREATIVE_ID - CREATIVE_TITLE - CREATIVE_TYPE - CREATIVE_MAIN_ASSET_URL - CREATIVE_FORMAT - CREATIVE_VIDEO_DURATION_SECONDS - CREATIVE_VIDEO_END_CARD_TYPE - CREATIVE_IS_DCA - EXCHANGE_ID - SUB_PUBLISHER_TYPE - INVENTORY_TYPE default: UNKNOWN_GROUP_BY description: "Dimension enumerates available dimensions.\n\n - UNKNOWN_GROUP_BY: This value is not part of the API specification." dspAnalyticsOverviewDimensionFilter: type: object properties: dimension: $ref: '#/components/schemas/dspAnalyticsOverviewDimension' description: Dimension to filter on. operator: $ref: '#/components/schemas/dspAnalyticsOverviewDimensionFilterOperator' values: type: array items: type: string description: Values to filter by the dimension. description: AnalyticsOverviewDimensionFilter specifies a filter for the analytics overview dimensions. dspAnalyticsOverviewDimensionFilterOperator: type: string enum: - UNKNOWN_DIMENSION_OPERATOR - IN - NOT_IN default: UNKNOWN_DIMENSION_OPERATOR description: Operator for the dimension filter. dspAnalyticsOverviewExchangeColumn: type: object properties: id: type: string description: Unique ID of an exchange. description: ExchangeColumn represents a structured column containing exchange information. dspAnalyticsOverviewInventoryColumn: type: object properties: type: type: string description: Type of an ad slot inventory. description: InventoryColumn represents a structured column containing inventory information. dspAnalyticsOverviewMetric: type: string enum: - UNKNOWN_ORDER_BY_COLUMN - IMPRESSIONS - ENGAGED_VIEWS - CLICKS - INSTALLS - TARGET_ACTIONS - CONVERSIONS - SPEND - REVENUE - CTR - IPM - CPC - CPI - CPA - CPCONV - D1_KPI_ACTION - D1_KPI_USER - D1_PURCHASE - D1_PURCHASER - D1_REVENUE - D1_ROAS - D1_CPA - D3_KPI_ACTION - D3_KPI_USER - D3_PURCHASE - D3_PURCHASER - D3_REVENUE - D3_ROAS - D3_CPA - D7_KPI_ACTION - D7_KPI_USER - D7_PURCHASE - D7_PURCHASER - D7_REVENUE - D7_ROAS - D7_CPA - D14_KPI_ACTION - D14_KPI_USER - D14_PURCHASE - D14_PURCHASER - D14_REVENUE - D14_ROAS - D14_CPA - D30_KPI_ACTION - D30_KPI_USER - D30_PURCHASE - D30_PURCHASER - D30_REVENUE - D30_ROAS - D30_CPA - PAGE_VISITS - SESSIONS - CPS - CPPV - PVPI - DRIVEN_INSTALLS - MOLOCO_MEASURED_INSTALLS - MOLOCO_MEASURED_EQUAL_PRIORITY_WINDOW_INSTALLS - LANDING_2H - CPRE - UNIQUE_VISITORS - UNIQUE_PURCHASERS - CPUV - CPUP - PAGE_VISITS_1D - PAGE_VISITS_3D - PAGE_VISITS_7D - PAGE_VISITS_14D default: UNKNOWN_ORDER_BY_COLUMN description: "Metric enumerates available metrics.\n\n - UNKNOWN_ORDER_BY_COLUMN: This value is not part of the API\ \ specification.\n - D1_KPI_ACTION: D1\n - D3_KPI_ACTION: D3\n - D7_KPI_ACTION: D7\n - D14_KPI_ACTION: D14\n - D30_KPI_ACTION:\ \ D30\n - PAGE_VISITS: CTV-WEB METRICS + CTV-WEB RATIO METRICS\n - LANDING_2H: RE-ENGAGEMENT METRICS\n - UNIQUE_VISITORS:\ \ UNIQUE USER METRICS\n - PAGE_VISITS_1D: PAGE VISITS COHORT METRICS" dspAnalyticsOverviewMetricColumn: type: object properties: impressions: type: string format: int64 description: The total number of impressions. engaged_views: type: string format: int64 description: The total number of engaged views. clicks: type: string format: int64 description: The total number of clicks. installs: type: string format: int64 description: The total number of installs. conversions: type: string format: int64 description: The total number of conversions selected by a user. target_actions: type: string format: int64 description: The total number of CPA Campaign's target actions. spend: type: number format: double description: The total ads spending for the current row. revenue: type: number format: double description: The total revenue for the current row. ctr: type: number format: double description: The total ads CTR for the current row. ipm: type: number format: double description: The total ads IPM for the current row. cpc: type: number format: double description: The total ads CPC for the current row. cpi: type: number format: double description: The total ads CPI for the current row. cpa: type: number format: double description: The total ads CPA for the current row. cpconv: type: number format: double description: The total ads CPConv for the current row. cohort_kpi_action: $ref: '#/components/schemas/dspAnalyticsOverviewMetricCount' title: Cohort metrics cohort_kpi_user: $ref: '#/components/schemas/dspAnalyticsOverviewMetricCount' cohort_purchase: $ref: '#/components/schemas/dspAnalyticsOverviewMetricCount' cohort_purchaser: $ref: '#/components/schemas/dspAnalyticsOverviewMetricCount' cohort_revenue: $ref: '#/components/schemas/dspAnalyticsOverviewMetricRevenue' cohort_roas: $ref: '#/components/schemas/dspAnalyticsOverviewMetricRatio' cohort_cpa: $ref: '#/components/schemas/dspAnalyticsOverviewMetricRatio' landing_2h: type: string format: int64 title: ReEngagement metrics cpre: type: number format: double page_visits_1d: type: string format: int64 description: 'PAGE VISITS COHORT METRICS The total number of page visits within 1 day of the corresponding impression.' page_visits_3d: type: string format: int64 description: The total number of page visits within 3 days of the corresponding impression. page_visits_7d: type: string format: int64 description: The total number of page visits within 7 days of the corresponding impression. page_visits_14d: type: string format: int64 description: The total number of page visits within 14 days of the corresponding impression. description: MetricColumn represents a structured column containing metric numbers. dspAnalyticsOverviewMetricCount: type: object properties: d1: type: string format: int64 description: Cumulative count by day 1. d3: type: string format: int64 description: Cumulative count by day 3. d7: type: string format: int64 description: Cumulative count by day 7. d14: type: string format: int64 description: Cumulative count by day 14. d30: type: string format: int64 description: Cumulative count by day 30. description: MetricCount represents a structured column containing count metrics. dspAnalyticsOverviewMetricFilter: type: object properties: metric: $ref: '#/components/schemas/dspAnalyticsOverviewMetric' description: Metric to filter on. operator: $ref: '#/components/schemas/dspAnalyticsOverviewMetricFilterOperator' value: type: string description: Value to filter by the metric. description: AnalyticsOverviewMetricFilter specifies a filter for the analytics overview metrics. dspAnalyticsOverviewMetricFilterOperator: type: string enum: - UNKNOWN_METRIC_OPERATOR - EQ - GT - GE - LT - LE default: UNKNOWN_METRIC_OPERATOR description: Operator for the metric filter. dspAnalyticsOverviewMetricRatio: type: object properties: d1: type: number format: double description: Ratio by day 1. d3: type: number format: double description: Ratio by day 3. d7: type: number format: double description: Ratio by day 7. d14: type: number format: double description: Ratio by day 14. d30: type: number format: double description: Ratio by day 30. title: MetricRatio represents a structured column containing ratio metrics ( ROAS and CPA) dspAnalyticsOverviewMetricRevenue: type: object properties: d1: type: number format: double description: Cumulative revenue by day 1. d3: type: number format: double description: Cumulative revenue by day 3. d7: type: number format: double description: Cumulative revenue by day 7. d14: type: number format: double description: Cumulative revenue by day 14. d30: type: number format: double description: Cumulative revenue by day 30. description: MetricRevenue represents a structured column containing revenue metrics. dspAnalyticsOverviewOrderByFilter: type: object properties: dimension: $ref: '#/components/schemas/dspAnalyticsOverviewDimension' description: Dimension column. metric: $ref: '#/components/schemas/dspAnalyticsOverviewMetric' description: Metric Column. is_descending: type: boolean description: Whether it is descending order. description: AnalyticsOverviewOrderByFilter specifies a filter for the analytics overview order by. dspAnalyticsOverviewRow: type: object properties: date: type: string description: The date in the local timezone with 'YYYY-MM-DD' format. timezone: type: string description: Timezone. ad_account: $ref: '#/components/schemas/dspAnalyticsOverviewAdAccountColumn' description: AdAccount column. app: $ref: '#/components/schemas/dspAnalyticsOverviewAppColumn' description: App column. site: $ref: '#/components/schemas/dspAnalyticsOverviewSiteColumn' description: Site column. campaign: $ref: '#/components/schemas/dspAnalyticsOverviewCampaignColumn' description: Campaign column. ad_group: $ref: '#/components/schemas/dspAnalyticsOverviewAdGroupColumn' description: AdGroup column. metric: $ref: '#/components/schemas/dspAnalyticsOverviewMetricColumn' description: Metric column. traffic: $ref: '#/components/schemas/dspAnalyticsOverviewTrafficColumn' description: Traffic column. creative_group: $ref: '#/components/schemas/dspAnalyticsOverviewCreativeGroupColumn' title: Part of AnalyticsOverview Extension creative: $ref: '#/components/schemas/dspAnalyticsOverviewCreativeColumn' exchange: $ref: '#/components/schemas/dspAnalyticsOverviewExchangeColumn' sub_publisher: $ref: '#/components/schemas/dspAnalyticsOverviewSubPublisherColumn' inventory: $ref: '#/components/schemas/dspAnalyticsOverviewInventoryColumn' device: $ref: '#/components/schemas/dspAnalyticsOverviewDeviceColumn' description: Row defines one row of the overview query result. dspAnalyticsOverviewSiteColumn: type: object properties: id: type: string description: Unique ID of a Site. title: type: string description: Descriptive name of a Site. domain: type: string description: Domain of the site. description: SiteColumn represents a structured column containing site information. dspAnalyticsOverviewSubPublisherColumn: type: object properties: type: $ref: '#/components/schemas/dspAnalyticsOverviewSubPublisherColumnType' description: Type of a sub-publisher. This will be either App or Site. description: SubPublisherColumn represents a structured column containing sub-publisher information. dspAnalyticsOverviewSubPublisherColumnType: type: string enum: - UNKNOWN_TYPE - APP - SITE default: UNKNOWN_TYPE description: ' - UNKNOWN_TYPE: This value is not part of the API specification.' dspAnalyticsOverviewTrafficColumn: type: object properties: lat: type: string description: Flag indicating whether LAT option is on or not, "TRUE", "FALSE", or "NULL". description: TrafficColumn represents a structured column containing LAT information. dspAnalyticsOverviewType: type: string enum: - USER_ACQUISITION - REENGAGEMENT default: USER_ACQUISITION dspAnalyticsSKAdNetworkAdAccountColumn: type: object properties: id: type: string description: Unique ID of an ad-account. title: type: string description: Descriptive name of an ad-account. currency: $ref: '#/components/schemas/adcloudcommonCurrency' description: Contract currency in ISO-4217. description: AdAccountColumn represents a structured column containing ad-account information. dspAnalyticsSKAdNetworkAppColumn: type: object properties: id: type: string description: Unique ID of an App. title: type: string description: Descriptive name of an App. store_id: type: string description: Store ID of an App. description: AppColumn represents a structured column containing app information. dspAnalyticsSKAdNetworkCampaignColumn: type: object properties: id: type: string description: Unique ID of a Campaign. title: type: string description: Descriptive name of a Campaign. type: type: string description: Type of a Campaign. target_countries: type: array items: type: string description: Target country code list in ISO-3166 Alpha-3. country: type: string description: Representative target country code in ISO-3166 Alpha-3. description: CampaignColumn represents a structured column containing Campaign information. dspAnalyticsSKAdNetworkDimension: type: string enum: - UNKNOWN_DIMENSION - DATE - HOUR - TIMEZONE - AD_ACCOUNT_ID - AD_ACCOUNT_TITLE - AD_ACCOUNT_CURRENCY - APP_ID - APP_TITLE - APP_STORE_ID - CAMPAIGN_ID - CAMPAIGN_TITLE - CAMPAIGN_TYPE - CAMPAIGN_TARGET_COUNTRIES - CAMPAIGN_COUNTRY - TRAFFIC_LAT - TRAFFIC_SKAN_REQ - TRAFFIC_SKAN_BID - TRAFFIC_MMP_EFFECTIVE default: UNKNOWN_DIMENSION description: "Dimension enumerates available dimensions.\n\n - UNKNOWN_DIMENSION: This value is not part of the API\ \ specification.\n - AD_ACCOUNT_ID: AD_ACCOUNT\n - APP_ID: APP\n - CAMPAIGN_ID: CAMPAIGN\n - TRAFFIC_LAT: TRAFFIC" dspAnalyticsSKAdNetworkDimensionFilter: type: object properties: dimension: $ref: '#/components/schemas/dspAnalyticsSKAdNetworkDimension' description: Dimension to filter on. operator: $ref: '#/components/schemas/dspAnalyticsSKAdNetworkDimensionFilterOperator' values: type: array items: type: string description: Values to filter by the dimension. description: AnalyticsSKAdNetworkDimensionFilter specifies a filter for the SKAdNetwork analytics dimensions. dspAnalyticsSKAdNetworkDimensionFilterOperator: type: string enum: - UNKNOWN_DIMENSION_OPERATOR - IN - NOT_IN default: UNKNOWN_DIMENSION_OPERATOR description: Operator for the dimension filter. dspAnalyticsSKAdNetworkJob: type: object properties: id: type: string description: The ID of the job. description: The job information executed for the SKAdNetwork analytics query request. dspAnalyticsSKAdNetworkMetric: type: string enum: - UNKNOWN_METRIC - IMPRESSIONS - CLICKS - INSTALLS - INSTALLS_CT - MMP_CONVERSIONS - TARGET_ACTIONS - SPEND - REVENUE - SKAN_INSTALLS - SKAN_ACTIONS - SKAN_REVENUE - CTR - IPM - CPC - CPI - CPA - CPCONV - SKAN_CPA - SKAN_IPM - SKAN_CPI - SKAN_CONVERSION_VALUE_RATIO default: UNKNOWN_METRIC description: "Metric enumerates available metrics.\n\n - UNKNOWN_METRIC: This value is not part of the API specification.\n\ \ - IMPRESSIONS: DEFAULT METRICS\n - CTR: RATIO METRICS" dspAnalyticsSKAdNetworkMetricColumn: type: object properties: impressions: type: string format: int64 description: The total number of impressions. clicks: type: string format: int64 description: The total number of clicks. installs: type: string format: int64 description: The total number of installs. installs_ct: type: string format: int64 description: The total number of click-through installs. mmp_conversions: type: string format: int64 description: The total number counted based on the MMP kpi action event in Campaign. target_actions: type: string format: int64 description: The total number of CPA Campaign's target actions. spend: type: number format: double description: The total ads spending for the current row. revenue: type: number format: double description: The total revenue for the current row. skan_actions: type: string format: int64 description: The total number of SKAdNetwork actions for the current row. skan_installs: type: string format: int64 description: The total number of SKAdNetwork installs for the current row. skan_revenue: type: number format: double description: 'The total SKAdNetwork revenue for the current row. From the API version 1.5.1, it will be calculated as the average of the minimum and maximum sum values within the revenue interval of conversion events. For previous API versions, it will return the maximum sum value within the revenue interval of conversion events.' ctr: type: number format: double description: The total ads CTR for the current row. ipm: type: number format: double description: The total ads IPM for the current row. cpc: type: number format: double description: The total ads CPC for the current row. cpi: type: number format: double description: The total ads CPI for the current row. cpa: type: number format: double description: The total ads CPA for the current row. cpconv: type: number format: double description: The total ads CPConv for the current row. skan_ipm: type: number format: double description: The total ads SKAdNetwork IPM for the current row. skan_cpi: type: number format: double description: The total ads SKAdNetwork CPI for the current row. skan_cpa: type: number format: double description: The total ads SKAdNetwork CPA for the current row. skan_conversion_value_ratio: type: number format: double description: The rate of SKAN Conversion Values (0 ~ 63) to the total postbacks. description: MetricColumn represents a structured column containing metric numbers. dspAnalyticsSKAdNetworkMetricFilter: type: object properties: metric: $ref: '#/components/schemas/dspAnalyticsSKAdNetworkMetric' description: Metric to filter on. operator: $ref: '#/components/schemas/dspAnalyticsSKAdNetworkMetricFilterOperator' value: type: string description: Value to filter by the metric. description: AnalyticsSKAdNetworkMetricFilter specifies a filter for the SKAdNetwork analytics metrics. dspAnalyticsSKAdNetworkMetricFilterOperator: type: string enum: - UNKNOWN_METRIC_OPERATOR - EQ - GT - GE - LT - LE default: UNKNOWN_METRIC_OPERATOR description: Operator for the metric filter. dspAnalyticsSKAdNetworkOrderByFilter: type: object properties: dimension: $ref: '#/components/schemas/dspAnalyticsSKAdNetworkDimension' description: Dimension column. metric: $ref: '#/components/schemas/dspAnalyticsSKAdNetworkMetric' description: Metric column. is_descending: type: boolean description: Whether it is descending order. description: AnalyticsSKAdNetworkOrderByFilter specifies a filter for the SKAdNetwork analytics order by. dspAnalyticsSKAdNetworkRow: type: object properties: date: type: string description: The date in the local timezone with 'YYYY-MM-DD' format. hour: type: integer format: int32 description: Hour in the local timezone. timezone: type: string description: Timezone. ad_account: $ref: '#/components/schemas/dspAnalyticsSKAdNetworkAdAccountColumn' description: AdAccount column. app: $ref: '#/components/schemas/dspAnalyticsSKAdNetworkAppColumn' description: App column. campaign: $ref: '#/components/schemas/dspAnalyticsSKAdNetworkCampaignColumn' description: Campaign column. traffic: $ref: '#/components/schemas/dspAnalyticsSKAdNetworkTrafficColumn' description: Traffic column. metric: $ref: '#/components/schemas/dspAnalyticsSKAdNetworkMetricColumn' description: Metric column. skan_conversions: type: array items: type: object $ref: '#/components/schemas/AnalyticsSKAdNetworkSKANConversionColumn' description: List of SKAdNetwork Conversion Column. description: Row defines one row of the overview query result. dspAnalyticsSKAdNetworkTrafficColumn: type: object properties: lat: type: boolean description: Flag indicating whether LAT option is on or not. skan_req: type: boolean description: Flag indicating whether bid request contains SKAdNetwork extension. skan_bid: type: boolean description: Flag indicating whether bid response fills SKAdNetwork extensions. mmp_effective: type: boolean description: Flag indicating whether MMP attribution is effective. description: TrafficColumn represents a structured column containing LAT information. dspAudienceTargetingCondition: type: object properties: allowed_countries: type: array items: type: string description: Allowed countries in ISO_3166-1_alpha-3 format. blocked_countries: type: array items: type: string description: Blocked countries in ISO_3166-1_alpha-3 format. placement_reasons: type: array items: $ref: '#/components/schemas/AudienceTargetingConditionPlacementReason' custom_placement_reason: type: string description: The reason of the placement in free-form text. allowed_app_bundles: type: array items: type: string description: "App bundles. A bid-request having a matching publisher app bundle from the list\nwill be accepted.\n\ \nExample to target com.moloco.game or com.moloco.travel apps:\n\n \"allowed_app_bundles\": [ \"com.moloco.game\"\ , \"com.moloco.travel\" ]\n\nExample to exclude com.moloco.office app:\n\n \"blocked_app_bundles\": [ \"com.moloco.office\"\ \ ]" blocked_app_bundles: type: array items: type: string description: See the documentation for `allowed_app_bundles`. allowed_content_categories: type: array items: type: string description: "Filter for allowed publisher IAB categories.\n\nValid category values can be found in section \"5.1\ \ Content Categories\" in the \"OpenRTB API Specification\":\n https://github.com/openrtb/OpenRTB/blob/master/OpenRTB-API-Specification-Version-2-3-1-FINAL.pdf\n\ \nFor example: \"allowed_content_categories\": [ \"IAB26-1\" ]" blocked_content_categories: type: array items: type: string description: "Filter for blocked publisher IAB categories.\n\nValid category values can be found in section \"5.1\ \ Content Categories\" in the \"OpenRTB API Specification\":\n https://github.com/openrtb/OpenRTB/blob/master/OpenRTB-API-Specification-Version-2-3-1-FINAL.pdf\n\ \nFor example: \"blocked_content_categories\": [ \"IAB26-1\" ]" allowed_cities: type: array items: type: string description: "Allowed cities. A bid-request will be accepted when there is at least one\nmatch from the city list.\ \ Note that each element must be in\nthe form of \"city, region\" such as \"Seattle, WA\" in order to disambiguate\n\ the same city but different regions. The entry is case-insensitive\nand whitespace will be ignored.\n\nExample\ \ to target Seattle or Newyork:\n\n \"allowed_cities\": [ \"Seattle, WA\", \"Newyork, ny\" ]" blocked_cities: type: array items: type: string description: Blocked cities. allowed_creative_types: type: array items: $ref: '#/components/schemas/adcloudcommonCreativeType' description: Allowed Creative types. blocked_creative_types: type: array items: $ref: '#/components/schemas/adcloudcommonCreativeType' description: Blocked Creative types. allowed_websites: type: array items: type: string description: 'Allowed websites. A glob pattern can be used for matching. Ignored for app inventories. For example: "allowed_websites": [ "*youtube.com" ].' blocked_websites: type: array items: type: string description: 'Blocked websites. A glob pattern can be used for matching. Ignored for app inventories. For example: "blocked_websites": [ "*example.com" ].' allowed_geofences: type: array items: type: object $ref: '#/components/schemas/commonCircle' description: Allowed geofences. blocked_geofences: type: array items: type: object $ref: '#/components/schemas/commonCircle' description: Blocked geofences. allowed_exchanges: type: array items: $ref: '#/components/schemas/commonAdExchange' description: 'Allowed ad exchanges. Restricts targeting to bid only on the listed exchanges; an empty list places no restriction. MOLOCO_SDK is automatically included whenever the list is non-empty: submitting a non-empty list that omits MOLOCO_SDK will have it appended on the server side.' blocked_exchanges: type: array items: $ref: '#/components/schemas/commonAdExchange' description: 'Blocked ad exchanges. Excludes the listed exchanges from targeting. Adding MOLOCO_SDK to this list is rejected with PERMISSION_DENIED.' allowed_idfas: type: array items: type: string description: Allowed user IDFAs. IDFA supports glob; e.g. use "*f" to match all IDFAs ending with "f". blocked_idfas: type: array items: type: string description: Blocked user IDFAs. IDFA supports glob; e.g. use "*f" to match all IDFAs ending with "f". allowed_zipcodes: type: array items: type: string description: Allowed zipcodes. blocked_zipcodes: type: array items: type: string description: Blocked zipcodes. allowed_device_models: type: array items: type: string description: "Allowed device models.\n\nFor example:\n\n \"allowed_device_models\": [ \"KFFOWI\", \"KFGIWI\",\ \ \"KFTT\", \"KFJWA\" ]" blocked_device_models: type: array items: type: string description: Blocked device models. allowed_user_audience_tags: type: array items: type: string description: Allowed user custom audience tags. blocked_user_audience_tags: type: array items: type: string description: Blocked user custom audience tags. allowed_languages: type: array items: type: string description: 'Allowed languages. Languages in use mostly follow ISO 639-1 code(https://www.loc.gov/standards/iso639-2/php/code_list.php), e.g. "ko" for Korean and "en" for English.' blocked_languages: type: array items: type: string description: Blocked languages. allowed_device_types: type: array items: $ref: '#/components/schemas/commonDeviceType' description: 'Allowed device types. For example: "allowed_device_types": [ "HIGHEND_PHONE", "TABLET" ]' blocked_device_types: type: array items: $ref: '#/components/schemas/commonDeviceType' description: 'Blocked device types. For example: "allowed_device_types": [ "SET_TOP_BOX" ]' allowed_mostly_visited_countries: type: array items: type: string description: 'This filter checks user''s history of mostly visited countries against the specified countries in the condition, and passes a request if there is at least one common entry in both lists.' blocked_mostly_visited_countries: type: array items: type: string allowed_regions: type: array items: type: string description: Regions are to filter a bid-request based on its region information. blocked_regions: type: array items: type: string allowed_recent_campaign_activities: type: array items: type: object $ref: '#/components/schemas/AudienceTargetingConditionRecentCampaignActivityFilter' description: "Recent Campaign activities filter a bid-request by user's recent activity such as click or install\n\ in the last n days. The filter is satisfied if there is at least one satisfying condition among the list.\n\n\ Example to target a user who has a click event for com.moloco.gameapp:\n\n \"allowed_recent_campaign_activities\"\ : [\n {\n \"campaign_id\": \"com.moloco.gameapp\",\n \"event\": \"CLICK\"\n }\n ]\n\ \nExample to block a user who has a install event for com.moloco.officeapp within the past five days:\n\n \"\ blocked_recent_campaign_activities\": [\n {\n \"campaign_id\": \"com.moloco.officeapp\",\n \ \ \"event\": \"INSTALL\",\n \"last_n_days\": 5\n }\n ]" blocked_recent_campaign_activities: type: array items: type: object $ref: '#/components/schemas/AudienceTargetingConditionRecentCampaignActivityFilter' allowed_locations: type: array items: type: object $ref: '#/components/schemas/AudienceTargetingConditionLocationFilter' description: 'Location filter targets specific geo-locational audience using combined conditions of different types such as city, region, zipcode and geofence.' blocked_locations: type: array items: type: object $ref: '#/components/schemas/AudienceTargetingConditionLocationFilter' genders: type: array items: $ref: '#/components/schemas/commonGender' connection_types: type: array items: type: string description: 'Connection_types include ETHERNET, WIFI, CELL_UNKNOWN, CELL_2G, CELL_3G, CELL_4G. For example: "connection_types": [ "WIFI", "CELL_4G" ]' allowed_direct_deal_ids: type: array items: type: string description: "IDs of the allowed direct deals. A bid-request is accepted only if there is at least one matching\ \ id.\n\nFor example:\n\n \"allowed_direct_deal_ids\": [\n \"ip_9161499632014fe8b9ef60673a51b745\",\n \ \ \"ip_e13c0cb23dd54a8ea742b2af61e0712d\",\n \"ip_0cfeaebb190d47df8b86399232853e23\"\n ]" blocked_direct_deal_ids: type: array items: type: string description: IDs of the blocked direct deals. device_oses: type: array items: type: object $ref: '#/components/schemas/AudienceTargetingConditionDeviceOsFilter' description: Device OS requirements if specified. media_channel_type: $ref: '#/components/schemas/AudienceTargetingConditionMediaChannelType' description: Media channel types. new_users: $ref: '#/components/schemas/AudienceTargetingConditionNewUserFilter' description: "Filter to target only new users.\n\nExample to accept a bid-request for new users with earliest known\ \ activities within the last 5 days:\n\n \"new_users\": {\n \"last_n_days\": 5\n }" advertiser_id_types: type: array items: $ref: '#/components/schemas/commonAdvertiserIdType' description: Filter on advising ID types, including "ANDROID_IDFA" or "IOS_IDFA". allowed_video_types: type: array items: $ref: '#/components/schemas/dspAudienceTargetingConditionVideoType' description: Video type filter. Ignored when the bid request is not for video ads. blocked_video_types: type: array items: $ref: '#/components/schemas/dspAudienceTargetingConditionVideoType' weekly_schedules: type: array items: type: object $ref: '#/components/schemas/AudienceTargetingConditionWeeklyScheduleFilter' description: "Weekly schedule specifies more fine-grained time range filtering for days of a week. For example,\n\ this list can be used to specify commute time ranges in the morning and evening on workdays.\n\nExample to target\ \ 7-9 am and 5-7 pm during week days:\n\n \"weekly_schedules\": [\n {\n \"hour_range\": {\n\ \ \"start\": 7,\n \"end\": 9\n },\n \"days\": [ \"MON\", \"TUE\"\ , \"WED\", \"THU\", \"FRI\" ]\n },\n {\n \"hour_range\": {\n \"start\":\ \ 17,\n \"end\": 19\n },\n \"days\": [ \"MON\", \"TUE\", \"WED\", \"THU\", \"\ FRI\" ]\n }\n ]\n\nExample to target 10pm to 2am on Fridays and Saturdays:\n\n \"weekly_schedules\"\ : [\n {\n \"range\": {\n \"start\": 22,\n \"end\": 2\n },\n \ \ \"days\": [ \"FRI\", \"SAT\" ]\n }\n ]" allowed_gender_score: $ref: '#/components/schemas/adcloudcommonFloatingPointRange' description: 'Gender score filter uses approximated gender score probability distribution in the range of [0, 1], with 0 indicating a strong probability of male, and 1 indicating a strong probability of female. The filter is specified with a range of [start, end] to filter on user''s gender score.' blocked_gender_score: $ref: '#/components/schemas/adcloudcommonFloatingPointRange' allowed_ages: type: array items: type: object $ref: '#/components/schemas/adcloudcommonInterval' description: 'Age is used to filter based on user''s approximate age. A valid value must be in the exclusive range of (0, 100).' blocked_ages: type: array items: type: object $ref: '#/components/schemas/adcloudcommonInterval' allowed_ip_ranges: type: array items: type: string description: "IP net based condition. The CIDR format must be used for an entry such as\nhttps://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing.\n\ Note that both of IP v4 and v6 could be used at the same time.\n\nExample to block bid-requests with any IP within\ \ 32.76.52.0 - 32.76.52.255 or 127.0.0.0 - 127.255.255.255:\n\n \"blocked_ip_ranges\": [\n \"32.76.52.0/24\"\ ,\n \"127.0.0.0/8\"\n ]" blocked_ip_ranges: type: array items: type: string allowed_device_carriers: type: array items: type: string description: "Device carrier filter.\n\nExample to target SKT:\n\n \"allowed_device_carriers\": [ \"SKTelecom\"\ \ ]\n\n\nExample to exclude T-MOBILE and XFINITY Mobile\n\n \"blocked_device_carriers\": [ \"T-MOBILE\", \"\ XFINITY Mobile\" ]" blocked_device_carriers: type: array items: type: string allowed_keywords: type: array items: type: string description: 'Filter regarding ''keywords'' field in a bid request. If specified, an ad request must have at least one of the allowed keywords to satisfy the filter.' blocked_keywords: type: array items: type: string description: 'Filter regarding ''keywords'' field in a bid request. An ad request must not have any of the blocked keywords to satisfy the filter.' user_buckets: type: array items: type: object $ref: '#/components/schemas/adcloudcommonInterval' description: Filter for the user buckets. allowed_ad_units: type: array items: type: string description: '// Target timetree_i_prod or timetree_a_prod ad_units "condition": { "allowed_ad_units": [ "timetree_i_prod", "timetree_a_prod" ] } // Exclude timetree_i_test ad_unit "condition": { "blocked_ad_units": [ "timetree_i_test" ] }' title: 'Example:' blocked_ad_units: type: array items: type: string allowed_placements: type: array items: type: string description: placement (a group of ad_units) names. It is untied to ad_units, and follow the ad_unit's filtering rule. blocked_placements: type: array items: type: string allowed_banner_apis: type: array items: $ref: '#/components/schemas/commonBannerApi' description: '// Target MRAID_2 banner only "condition": { "allowed_banner_apis": [ "MRAID_2" ] }' title: 'Example:' blocked_banner_apis: type: array items: $ref: '#/components/schemas/commonBannerApi' schedule: $ref: '#/components/schemas/commonTimeInterval' description: "Schedule to allow bid-requests in a absolute time range, where start and end\nare in RFC3339 format.\ \ A few example from https://tools.ietf.org/html/rfc3999\nis listed below.\n\n 1985-04-12T23:20:50.52Z\n\n\ \ This represents 20 minutes and 50.52 seconds after the 23rd hour of\n April 12th, 1985 in UTC.\n\n\n 1996-12-19T16:39:57-08:00\n\ \n This represents 39 minutes and 57 seconds after the 16th hour of\n December 19th, 1996 with an offset of\ \ -08:00 from UTC (Pacific\n Standard Time). Note that this is equivalent to 1996-12-20T00:39:57Z\n in UTC.\n\ \n Example:\n\n // Christmas through end of the year\n \"condition\": {\n \"schedule\": {\n \ \ \"start\": \"2020-12-24T00:00:00Z\",\n \"end\": \"2020-12-31T23:59:59Z\"\n }\n }" audience_data: $ref: '#/components/schemas/commonAudienceData' description: "Audience data.\n\n Example:\n \"condition\": {\n \"audience_data\": {\n \"provider\"\ : \"moloco\",\n \"condition\": \"name == \\\"John\"\\ AND age > 30\"\n }\n }" allowed_apps_by_checksum: type: array items: type: string description: Allow apps by their checksum value. blocked_apps_by_checksum: type: array items: type: string description: Block apps by their checksum value. allowed_postback_event_counts: type: array items: type: object $ref: '#/components/schemas/commonPostbackEventCount' description: "PostbackEventCount condition checks the number of specified events and\naccepts if there is one event\ \ that falls within given range of [start,\nend). In the example, User's event named \"Transaction confirmation\"\ \nmust have been appeared 16 times or more to accept for zigbang app.\n\n Example:\n \"condition\": {\n \ \ \"allowed_postback_event_counts\": [\n {\n \"app_bundle\": \"com.chbreeze.jikbang4a\"\ ,\n \"range\": {\n \"start\": 16,\n \"end\": 0\n \ \ },\n \"events\": [\n \"Transaction confirmation\"\n ]\n \ \ }\n ]\n }" auction_types: type: array items: type: string description: "Auction types including first price or second price auctions.\n\n Example:\n \"condition\": {\n\ \ \"auction_types\": [ \"first\", \"second\" ]\n }" throttle_apt_tags: $ref: '#/components/schemas/commonTagsThrottleCondition' title: "Allow throttle apps with apt tags with throttle rate. In the example,\nthrottle apps with apt_tags [bad_apptag1,\ \ bad_apptag2] with 95% of throttle rate\nare allowed.\nExample:\n\"condition\":{\n \"throttle_apt_tags\": {\n\ \ \"tags\": [\"badapp_tag1\", \"badapp_tag2\"],\n \"throttle_rate\": 0.95\n }\n}" allowed_dev_makes: type: array items: type: string description: "Allowed device make.\n\n Example:\n \"condition\":{\n \"allowed_dev_makes\": [ \"Apple\"\ \ ]\n }" blocked_dev_makes: type: array items: type: string description: Blocked device make. See the example of `allowed_dev_makes`. display_manager_versions: type: array items: type: object $ref: '#/components/schemas/commonDisplayManagerVersion' description: "DisplayManager Version.\n\n Example:\n\n \"condition\": {\n \"display_manager_versions\"\ : [\n {\n \"min\": \"1.2\",\n \"max\": \"4.5.6\"\n }\n ]\n\ \ }\n\n // With minimum version requirement:\n \"condition\": {\n \"display_manager_versions\": [\n\ \ {\n \"min\": \"3.0\"\n }\n ]\n }\n\n // With maximum version requirement:\n\ \ \"condition\": {\n \"display_manager_versions\": [\n {\n \"max\": \"5\"\n \ \ }\n ]\n }" allowed_audiences: type: array items: type: string description: Allowed audiences. blocked_audiences: type: array items: type: string description: Blocked audiences. allowed_postback_has_all_events_conditions: type: array items: type: object $ref: '#/components/schemas/commonPostbackEventsCondition' description: 'Postback event condition filter a bid-request by user''s postback summary. Note that audience name and events are of case-sentitive string types. Each entry of allowed_postback_has_all_events_conditions will be satisfied when all listed events are found from user''s postback summary.' blocked_postback_has_all_events_conditions: type: array items: type: object $ref: '#/components/schemas/commonPostbackEventsCondition' description: 'Each entry of blocked_postback_has_all_events_conditions will be satisfied when all listed events are not found from user''s postback summary.' allowed_postback_has_any_events_conditions: type: array items: type: object $ref: '#/components/schemas/commonPostbackEventsCondition' title: "Each entry of allowed_postback_has_any_events_conditions will be satisfied when there is at least\none matching\ \ event by the condition from user's postback summary.\nThe following example defines in-app events of \"com.moloco.gameapp\"\ \ for a user bound to the\nbid-request. The condition must have both of \"adview\" and \"purchase\" events within\ \ the\npast 14 days but no \"Open\" or \"Close\" events in the last 7 days.\nExample:\n \"condition\": {\n \ \ \"allowed_postback_has_all_events_conditions\": [\n {\n \"audiences\": [ \"com.moloco.gameapp\"\ \ ],\n \"events\": [ \"adview\", \"purchase\" ],\n \"past_time_range\": {\n \ \ \"start\": 14\n }\n }\n ],\n \"blocked_postback_has_any_events_conditions\"\ : [\n {\n \"audiences\": [ \"com.moloco.gameapp\" ],\n \"events\": [ \"\ Open\", \"Close\" ],\n \"past_time_range\": {\n \"start\": 7\n }\n\ \ }\n ]\n }" blocked_postback_has_any_events_conditions: type: array items: type: object $ref: '#/components/schemas/commonPostbackEventsCondition' description: 'Each entry of blocked_postback_has_any_events_conditions will be satisfied when there is at least one event not matched by the condition from user''s postback summary. See the documentation for `allowed_postback_has_any_events_conditions`.' allowed_location_set: $ref: '#/components/schemas/AudienceTargetingConditionLocationSet' description: 'Allowed and blocked location sets. If these fields are set, allowed_location_codes and blocked_location_codes are ignored.' blocked_location_set: $ref: '#/components/schemas/AudienceTargetingConditionLocationSet' allowed_apt_tags: type: array items: type: string blocked_apt_tags: type: array items: type: string coppa_acceptance: $ref: '#/components/schemas/AudienceTargetingConditionCoppaAcceptance' description: Whether to bid according to BidRequest.regs.coppa value. skan_traffic: $ref: '#/components/schemas/AudienceTargetingConditionSkanTraffic' description: 'Whether to bid according to bid requests that support SKAN or not. Decide based on bidreq.ext.sk_ad_network_request_ext field exists.' contains_custom_audience: type: boolean description: 'Whether it contains a `custom_audience` targeting condition. The `custom_audience` targeting condition is legacy, and may contain some internal information. Therefore, we do not reveal them by the API but only signals its non-emptiness with this field.' custom_audience_set: $ref: '#/components/schemas/AudienceTargetingConditionCustomAudienceSet' description: 'CustomAudienceSet is a combination of app events and user lists filters. The app events filter checks if the targeted user conforms to given app events. The CustomerSet filter checks if an entry in the list can be found from tags in a user profile. There is an assumption that a CustomerSet entity exists for each and every entry in the list.' description: 'AudienceTargetingCondition specifies conditions for AudienceTargeting. This condition object contains various filters on multiple dimensions of bid-request, app, and user. Advertisers can selectively configure desired filters to form a meaningful AudienceTarget condition collectively. The configured individual filters must be satisfied unanimously in order for the resulting collective condition to be satisfied. Only filters with values will be effective. When a filter condition accepts a list of values, i.e., list of countries for "allowed_countries", the filter condition will be met when any match is found among the list. String literals are case insensitive unless specified otherwise; i.e. "USA" and "usa" equally represents the United States of America.' dspAudienceTargetingConditionVideoType: type: string enum: - UNKNOWN_VIDEO_TYPE - REWARD_VIDEO - NON_REWARD_VIDEO - NON_VIDEO default: UNKNOWN_VIDEO_TYPE description: This value is not part of the specification. dspBudgetSchedule: type: object properties: daily_schedule: $ref: '#/components/schemas/dspDailyBudgetSchedule' description: Budget for every day. weekly_schedule: $ref: '#/components/schemas/dspDayOfWeekBudgetSchedule' description: Budget for each day-of-week. weekly_flexible_schedule: $ref: '#/components/schemas/dspWeeklyFlexibleBudgetSchedule' description: Budget for a week. description: 'BudgetSchedule represents the AdAccount''s plan for budget spending. Any change in this object takes effect immediately.' dspBusinessCategory: type: string enum: - BUSINESS_CATEGORY_UNKNOWN - BUSINESS_CATEGORY_GAME - BUSINESS_CATEGORY_COMMERCE - BUSINESS_CATEGORY_ENTERTAINMENT - BUSINESS_CATEGORY_FINTECH - BUSINESS_CATEGORY_FNB - BUSINESS_CATEGORY_ONDEMAND - BUSINESS_CATEGORY_SOCIAL_NETWORK - BUSINESS_CATEGORY_OTHERS default: BUSINESS_CATEGORY_UNKNOWN description: Category of the business. dspCampaign: type: object properties: id: type: string description: Unique identifier of the Campaign. Automatically set by server on creation. ad_account_id: type: string description: ID of the AdAccount the Campaign belongs to. readOnly: true product_id: type: string description: ID of the Product the Campaign belongs to. readOnly: true title: type: string description: A descriptive name of the Campaign. description: type: string description: An optional description of the Campaign. enabling_state: $ref: '#/components/schemas/commonEnablingState' description: 'Whether this campaign is enabled by the AdAccount. Only enabled Campaigns will be activated for serving once their eligibility is determined by Moloco. If the value of this field is unset or set to UNSPECIFIED in a Campaign creation request, it will be set to ENABLED automatically by the server. If the value is DISABLED when the Campaign is being reviewed and approved, the Campaign state will become PAUSED after approval. An active Campaign can be paused manually at any time by setting this field to DISABLED.' type: $ref: '#/components/schemas/dspCampaignType' description: Type of the Campaign. device_os: $ref: '#/components/schemas/commonDeviceOs' description: Device OS type for this Campaign. state: $ref: '#/components/schemas/dspCampaignState' description: State of the Campaign. This state will be fully managed by the server. readOnly: true countries: type: array items: type: string description: 'Countries in which this Campaign runs. The value format is ISO-3166-1 Alpha-3 using uppercase letters only, such as "KOR" or "USA". Note that the values for this field will be used to filter bid requests by country name.' currency: $ref: '#/components/schemas/adcloudcommonCurrency' description: 'Currency used for the Campaign. Set by the ad account''s currency setting.' readOnly: true schedule: $ref: '#/components/schemas/commonTimeInterval' description: 'Absolute time range to allow this Campaign to be served. Start is required and End is optional.' budget_schedule: $ref: '#/components/schemas/dspBudgetSchedule' description: Campaign-wide budget schedule specified by the AdAccount. tracking_company: $ref: '#/components/schemas/adcloudcommonTrackingCompany' description: Tracking company (e.g., Appsflyer, MAT, and so on). tracking_link_id: type: string description: 'MMP specific impression and click TrackingLinks defined specifically for this Campaign. Campaign can be either WEB type or APP type. Required for APP type campaign, not allowed for WEB type Campaign.' landing_url: type: string description: 'The URL of the website that a Campaign wants to show to the audience. Required for web type Campaign.' goal: $ref: '#/components/schemas/dspCampaignGoal' description: Goal of the Campaign. skadn_input: $ref: '#/components/schemas/dspSKAdNetworkInput' description: 'Explicit input for SKAdNetwork traffic. It''s meaningful only for IOS App Campaign toward SKAdNetwork traffic.' custom_key_values: type: object additionalProperties: type: string description: 'Custom key/values managed by the Moloco Ads client platform. It''s up to the client ads platform to define the schema for the values and their optionality. The keys are recommended, but not required, to be prefixed with the reversed internet domain of the AdCloud client platform company. For example, keys defined by the client ads platform company "example.com" should have "com.example." as the prefix. For complex values, JSON payload is recommended. Moloco doesn''t interpret these data in any way for ads serving. Upon serving, the custom key/values in the AdAccount, Campaign, and Creative models will be combined into the serving Creative proto in the order of precedence, with Creative''s value having the highest precedence on the same key.' ad_tracking_allowance: $ref: '#/components/schemas/dspAdTrackingAllowance' description: AdTrackingAllowance controls target audience in terms of personalized ad tracking settings. is_deleted: type: boolean description: True for deleted Campaign. readOnly: true auto_delete_at: type: string format: date-time description: 'Campaign in Paused or Finished state for specific time will be removed automatically. It represents when this will be deleted in UTC.' readOnly: true created_at: type: string format: date-time description: Created time. readOnly: true updated_at: type: string format: date-time description: Last updated time. Should not modify on the client side. serving_status: $ref: '#/components/schemas/CampaignServingStatus' readOnly: true launch_notices: type: array items: type: object $ref: '#/components/schemas/commonLaunchNotice' description: 'A list of notices that the user must review and acknowledge to enable the campaign. This field represents pending notices requiring user confirmation. The client should store these notices and include them in the subsequent request via the ''launch_notice_confirmations'' field to prove that the user has seen them.' readOnly: true launch_notice_confirmations: type: array items: type: object $ref: '#/components/schemas/commonLaunchNotice' description: 'The list of launch notice that the user has explicitly reviewed and confirmed. The client must echo back the notices received in ''launch_notices'' when enabling the campaign. The server validates these against the current system state to ensure all required acknowledgments are present. Starting from v1.10.0, any campaign enable request that does not include all ''DISCLAIMER'' type notices received in ''launch_notices'' will be rejected.' description: Campaign represents a single advertising Campaign. required: - type - device_os - schedule - goal - title - countries dspCampaignGoal: type: object properties: type: $ref: '#/components/schemas/dspCampaignGoalType' description: Type of the goal. optimize_app_installs: $ref: '#/components/schemas/CampaignGoalOptimizeAppInstalls' optimize_cpa_for_app_ua: $ref: '#/components/schemas/CampaignGoalOptimizeCpaForAppUa' optimize_app_roas: $ref: '#/components/schemas/CampaignGoalOptimizeAppRoas' optimize_clicks_to_web: $ref: '#/components/schemas/CampaignGoalOptimizeClicksToWeb' optimize_clicks_to_app: $ref: '#/components/schemas/CampaignGoalOptimizeClicksToApp' optimize_roas_for_app_re: $ref: '#/components/schemas/CampaignGoalOptimizeRoasForAppRe' optimize_cpc_for_app_re: $ref: '#/components/schemas/CampaignGoalOptimizeCpcForAppRe' optimize_fixed_cpm: $ref: '#/components/schemas/CampaignGoalOptimizeFixedCpm' optimize_cpa_for_app_re: $ref: '#/components/schemas/CampaignGoalOptimizeCpaForAppRe' optimize_app_retention: $ref: '#/components/schemas/CampaignGoalOptimizeAppRetention' optimize_app_reattribution: $ref: '#/components/schemas/CampaignGoalOptimizeAppReattribution' optimize_cpa_repeated_for_app_ua: $ref: '#/components/schemas/CampaignGoalOptimizeCpaRepeatedForAppUa' optimize_fixed_cpm_pacing: $ref: '#/components/schemas/CampaignGoalOptimizeFixedCpmPacing' optimize_landing_for_web_ua: $ref: '#/components/schemas/CampaignGoalOptimizeLandingForWebUa' optimize_cpa_for_web_ua: $ref: '#/components/schemas/CampaignGoalOptimizeCpaForWebUa' kpi_actions: type: array items: type: string description: List of KPI actions. description: CampaignGoal describes the details of goal of a Campaign. required: - type dspCampaignGoalType: type: string enum: - UNKNOWN_TYPE - OPTIMIZE_NONE - FIXED_CPM_FOR_APP_UA - FIXED_CPM_FOR_APP_RE - OPTIMIZE_CPI_FOR_APP_UA - OPTIMIZE_CPA_FOR_APP_UA - OPTIMIZE_CPC_FOR_APP_UA - OPTIMIZE_ROAS_FOR_APP_UA - OPTIMIZE_ROAS_FOR_APP_RE - OPTIMIZE_CPC_FOR_APP_RE - OPTIMIZE_CPC_FOR_WEB_VISIT - OPTIMIZE_APP_INSTALLS - OPTIMIZE_APP_ROAS - OPTIMIZE_CLICKS_TO_WEB - OPTIMIZE_CLICKS_TO_APP - OPTIMIZE_CPA_FOR_APP_RE - OPTIMIZE_RETENTION_FOR_APP_UA - OPTIMIZE_REATTRIBUTION_FOR_APP - OPTIMIZE_CPA_REPEATED_FOR_APP_UA - FIXED_CPM_GENERIC - FIXED_CPM_FOR_CTV - FIXED_CPM_FOR_WEB_VISIT - OPTIMIZE_LANDING_FOR_WEB_UA - OPTIMIZE_CPA_FOR_WEB_UA default: UNKNOWN_TYPE description: "Type enumerates available Campaign goal types.\nCorresponding details to the type must be specified.\n\ \n - OPTIMIZE_NONE: Goal type for the Campaigns which do not use any of pricing engines.\n - FIXED_CPM_FOR_APP_UA:\ \ Goal type for the UA Campaigns which do not use any of pricing engines.\n - FIXED_CPM_FOR_APP_RE: Goal type for\ \ the RE Campaigns which do not use any of pricing engines.\n - OPTIMIZE_CPI_FOR_APP_UA: Aim to drive app installs\ \ while satisfying the long-term cost per install.\n - OPTIMIZE_CPA_FOR_APP_UA: Aim to drive app installs while satisfying\ \ long-term cost per (certain) action.\n - OPTIMIZE_CPC_FOR_APP_UA: Aim to drive app installs while satisfying long-term\ \ cost per click.\n - OPTIMIZE_ROAS_FOR_APP_UA: Aim to drive app installs while satisfying long-term return on advertising\ \ spend (ROAS).\n - OPTIMIZE_ROAS_FOR_APP_RE: Aim to drive the user re-engagements while satisfying long-term return\ \ on advertising spend (ROAS).\n - OPTIMIZE_CPC_FOR_APP_RE: Aim to drive the user re-engagements while satisfying\ \ long-term cost per click.\n - OPTIMIZE_CPC_FOR_WEB_VISIT: Aim to drive the web-site visit while satisfying long-term\ \ cost per click.\n - OPTIMIZE_APP_INSTALLS: Deprecated. Aim to drive app installs while satisfying long-term cost\ \ per install.\n - OPTIMIZE_APP_ROAS: Deprecated. Aim to drive certain in-app actions while satisfying long-term return\ \ on advertising spend (ROAS).\n - OPTIMIZE_CLICKS_TO_WEB: Deprecated. Aim to drive clicks for web-site Product while\ \ satisfying long-term cost per click.\n - OPTIMIZE_CLICKS_TO_APP: Deprecated. Aim to drive clicks for web-site Product\ \ while satisfying long-term cost per click.\n - OPTIMIZE_CPA_FOR_APP_RE: Aim to drive the user re-engagements while\ \ satisfying long-term cost per (certain) action.\n - OPTIMIZE_RETENTION_FOR_APP_UA: Aim to drive the user retention.\n\ \ - OPTIMIZE_REATTRIBUTION_FOR_APP: Aim to drive user's app reattribution.\n - OPTIMIZE_CPA_REPEATED_FOR_APP_UA: Aim\ \ to drive app installs while satisfying long-term cost per (certain) action - repeated count.\n - FIXED_CPM_GENERIC:\ \ Default goal type for generic fixed-cpm. Fixed cpm with budget-pacing option is given.\n - FIXED_CPM_FOR_CTV: Default\ \ goal type for CTV. Fixed cpm with budget-pacing option is given.\n - FIXED_CPM_FOR_WEB_VISIT: Goal type for the\ \ WEB_VISIT Campaigns which do not use any of pricing engines.\n - OPTIMIZE_LANDING_FOR_WEB_UA: Goal type for optimizing\ \ landing event for web user acquisition campaign.\n - OPTIMIZE_CPA_FOR_WEB_UA: Goal type for optimizing cost per\ \ action for web user acquisition campaign." dspCampaignState: type: string enum: - UNKNOWN_CAMPAIGN_STATE - SUBMITTED - READY - UPCOMING - ACTIVE - PAUSED - SUSPENDED - COMPLETED default: UNKNOWN_CAMPAIGN_STATE description: "CampaignState represents various states of a Campaign.\n\nThis value is not part of the specification.\n\ \n - SUBMITTED: All the required data are entered and passed all the validation. It's eligible\nto be reviewed by\ \ Moloco for activation.\n - READY: Campaign is before schedule and internally ready but disabled.\nWill transit to\ \ PAUSED when it becomes on schdule.\n - UPCOMING: Campaign is before schedule and internally ready and disabled.\n\ Will transit to ACTIVE when it becomes on schdule.\n - ACTIVE: Campaign is on schedule and spending the budget.\n\ \ - PAUSED: Campaign is paused and not spending the budget.\n - SUSPENDED: Campaign activation is suspended by the\ \ system for the following reasons:\n- App has been found to be in violation of Moloco's creative policy.\n - COMPLETED:\ \ Campaign is completed but may still get attributions for some time." dspCampaignType: type: string enum: - UNKNOWN_CAMPAIGN_TYPE - GENERIC - APP_USER_ACQUISITION - APP_REENGAGEMENT - WEBSITE_VISIT - CTV_GENERIC - CTV_APP_USER_ACQUISITION - WEB_USER_ACQUISITION - CTV_WEBSITE_VISIT - WEB_RETARGETING default: UNKNOWN_CAMPAIGN_TYPE description: "CampaignType represents the type of a Campaign.\nIt captures the goal of the Campaign at a high level.\n\ \nThis value is not part of the specification.\n\n - GENERIC: Campaign is for generic purpose (only for legacy Campaigns).\n\ \ - APP_USER_ACQUISITION: The goal of the Campaign is to drive app user acquisitions.\n - APP_REENGAGEMENT: The goal\ \ of the Campaign is to drive app reengagement.\n - WEBSITE_VISIT: The goal of the Campaign is to drive website visits.\n\ \ - CTV_GENERIC: Campaign is for the general CTV ad.\n - CTV_APP_USER_ACQUISITION: Campaign is for the mobile app\ \ install CTV ad.\n - WEB_USER_ACQUISITION: The goal of the Campaign is to drive web user acquisitions.\nOriginally,\ \ this was used for APP to WEB user acquisition. However,\nit is now also used for WEB to WEB user acquisition.\n\ \ - CTV_WEBSITE_VISIT: Campaign is for the website visit CTV ad.\n - WEB_RETARGETING: The goal of the Campaign is\ \ to drive web retargeting.\nCurrently, this is used for WEB to WEB retargeting." dspClientType: type: string enum: - UNKNOWN_CLIENT_TYPE - ADVERTISER - AGENCY default: UNKNOWN_CLIENT_TYPE description: "Enumerates available client types.\n\n - ADVERTISER: The actual advertiser, who owns the advertising apps\ \ or web sites.\n - AGENCY: An agency, who usually operates ad campaigns on behalf of the advertiser." dspCohortMetricType: type: string enum: - UNKNOWN - ROAS - KPI_ACTION - UA_ROAS - UA_KPI_ACTION - RE_ROAS - RE_KPI_ACTION default: UNKNOWN description: "CohortMetricType represents a cohort metric type.\n\nUnknown cohort metric type.\n\n - ROAS: Deprecated.\n\ \ - KPI_ACTION: Deprecated.\n - UA_ROAS: Cohort ROAS metric type for user acquisition Campaigns.\n - UA_KPI_ACTION:\ \ Cohort KPI actions metric type for user acquisition Campaigns.\n - RE_ROAS: Cohort ROAS metric type for re-engagement\ \ Campaigns.\n - RE_KPI_ACTION: Cohort KPI actions metric type for re-engagement Campaigns." dspCohortSummaryActionColumn: type: object properties: revenue_actions: $ref: '#/components/schemas/CohortSummaryRevenueActionColumn' description: Revenue events and cohort metrics. kpi_actions: $ref: '#/components/schemas/dspCohortSummaryKpiActionColumn' description: KPI events and cohort metrics. description: 'ActionColumn represents a structured column containing cohort metrics by days for an event.' dspCohortSummaryAppColumn: type: object properties: id: type: string description: Unique ID of an App. title: type: string description: Descriptive name of an App. os: $ref: '#/components/schemas/commonDeviceOs' description: OS type of an App. description: AppColumn represents a structured column containing app information. dspCohortSummaryCampaignColumn: type: object properties: id: type: string description: Unique ID of a Campaign. title: type: string description: Descriptive name of a Campaign. country: type: string description: Country code in ISO-3166 Alpha-3. is_lat: type: boolean description: Whether the bid was towards LAT (Limit Ad Tracking) device. description: 'CampaignColumn represents a structured column containing Campaign information.' dspCohortSummaryKpiActionColumn: type: object properties: event: type: string description: Name of an event. event_count: $ref: '#/components/schemas/dspCohortSummaryMetricCount' description: Cumulative count of an event by specified days. user_count: $ref: '#/components/schemas/dspCohortSummaryMetricCount' description: Cumulative count of unique users for an event by specified days. description: 'KpiActionColumn represents a structured column containing cohort metrics by days for a KPI event.' dspCohortSummaryMetricCount: type: object properties: d1: type: string format: int64 description: Cumulative count by day 1. d3: type: string format: int64 description: Cumulative count by day 3. d7: type: string format: int64 description: Cumulative count by day 7. d30: type: string format: int64 description: Cumulative count by day 30. description: MetricCount represents a structured column containing count metrics. dspCohortSummaryMetricRevenue: type: object properties: d1: type: number format: double description: Cumulative revenue by day 1. d3: type: number format: double description: Cumulative revenue by day 3. d7: type: number format: double description: Cumulative revenue by day 7. d30: type: number format: double description: Cumulative revenue by day 30. description: MetricRevenue represents a structured column containing revenue metrics. dspCohortSummaryRow: type: object properties: date: type: string description: The date in the local timezone with 'YYYY-MM-DD' format. app: $ref: '#/components/schemas/dspCohortSummaryAppColumn' description: App column. site: $ref: '#/components/schemas/dspCohortSummarySiteColumn' description: Site column. campaign: $ref: '#/components/schemas/dspCohortSummaryCampaignColumn' description: 'CampaignColumn represents a structured column containing Campaign information.' currency: $ref: '#/components/schemas/adcloudcommonCurrency' description: Contract currency. spend: type: number format: double description: The amount of ad spend in contract currency. base_event_count: type: string format: int64 description: Count of the cohort base action. event_count: $ref: '#/components/schemas/dspCohortSummaryMetricCount' description: Cumulative action count of the date. user_count: $ref: '#/components/schemas/dspCohortSummaryMetricCount' description: Cumulative user count of the date. revenue: $ref: '#/components/schemas/dspCohortSummaryMetricRevenue' description: 'Cumulative revenue of the date in contract currency. Revenue is populated when ActionColumn is RevenueAction.' action_column: type: array items: type: object $ref: '#/components/schemas/dspCohortSummaryActionColumn' description: Action column holds aggregated cohort data per event. sub_publisher: $ref: '#/components/schemas/dspCohortSummarySubPublisherColumn' description: SubPublisher column. description: A row in the cohort summary table consisting of columns. dspCohortSummarySiteColumn: type: object properties: id: type: string description: Unique ID of a Site. title: type: string description: Descriptive name of a Site. description: SiteColumn represents a structured column containing site information. dspCohortSummarySubPublisherColumn: type: object properties: type: $ref: '#/components/schemas/dspCohortSummarySubPublisherColumnType' description: Type of a sub-publisher. This will be either App or Site. description: SubPublisherColumn represents a structured column containing sub-publisher information. dspCohortSummarySubPublisherColumnType: type: string enum: - UNKNOWN_TYPE - APP - SITE default: UNKNOWN_TYPE description: ' - UNKNOWN_TYPE: This value is not part of the API specification.' dspCompanyInfo: type: object properties: name: type: string description: Name of the Company. client_type: $ref: '#/components/schemas/dspClientType' title: Client business type of the company. e.g. Advertiser, Agency category: $ref: '#/components/schemas/dspBusinessCategory' title: Category of the business. e.g. Game finance_email: type: string description: Email account in charge of the finance. address: type: string description: Address of the company. sub_address: type: string description: Sub address of the company. city: type: string description: City of the company. state: type: string description: State of the company. country: type: string description: Country of the company. zipcode: type: string description: Zipcode of the company. description: CompanyInfo holds the company information. required: - client_type - category - name - finance_email - address - city - country - zipcode dspCreative: type: object properties: id: type: string description: Unique identifier of the Creative. Automatically set by server on creation. ad_account_id: type: string description: ID of the AdAccount the Creative belongs to. readOnly: true product_id: type: string description: ID of the Product the Creative belongs to. readOnly: true title: type: string description: A descriptive name of the Creative. enabling_state: $ref: '#/components/schemas/commonEnablingState' description: 'Whether this Creative is enabled by the AdAccount. If the value of this field is unset or set to UNSPECIFIED in the Creative creation request, it will be set to ENABLED by default by the server. A disabled Creative will still get reviewed, but won''t be served automatically after approval. An active serving Creative can be paused at any time by setting this field to DISABLED.' advertiser_info: $ref: '#/components/schemas/dspAdvertiserInfo' description: Basic information about the Creative's AdAccount. readOnly: true type: $ref: '#/components/schemas/dspCreativeType' description: Type of the Creative. original_filename: type: string description: Original Creative filename given by user. size_in_bytes: type: integer format: int64 description: Estimated size of the Creative in bytes. custom_key_values: type: object additionalProperties: type: string description: 'Custom key/values managed by the Moloco Ads client platform. It''s up to the client ads platform to define the schema for the values and their optionality. The keys are recommended, but not required, to be prefixed with the reversed internet domain of the AdCloud client platform company. For example, keys defined by the client ads platform company "example.com" should have "com.example." as the prefix. For complex values, JSON payload is recommended. Moloco doesn''t interpret these data in any way for ads serving. Upon serving, the custom key/values in the AdAccount, Campaign, and Creative models will be combined into the serving Creative proto in the order of precedence, with Creative''s value having the highest precedence on the same key.' image: $ref: '#/components/schemas/dspCreativeImageSrc' video: $ref: '#/components/schemas/dspCreativeVideoSrc' vast_video: $ref: '#/components/schemas/dspCreativeVastVideoSrc' native: $ref: '#/components/schemas/dspCreativeNativeSrc' custom_html: $ref: '#/components/schemas/dspCreativeCustomHtmlSrc' template_html: $ref: '#/components/schemas/dspCreativeTemplateHtmlSrc' rich_custom_html: $ref: '#/components/schemas/dspCreativeRichCustomHtmlSrc' dynamic_html: $ref: '#/components/schemas/dspCreativeDynamicHtmlSrc' feature_type: $ref: '#/components/schemas/adcloudcommonCreativeFeatureType' description: CreativeFeatureType. creator_tag: type: string description: Creator tag to identify who is the resource creator. created_at: type: string format: date-time description: Created time. readOnly: true updated_at: type: string format: date-time description: Last updated time. Should not modify on the client side. description: 'Creative contains all data and assets required to visually render an ad. One and only one of the sources must be specified for the Creative.' required: - title - original_filename dspCreativeCustomHtmlSrc: type: object properties: html: type: string description: HTML for the custom HTML ad. width: type: integer format: int64 description: Width of the Creative. height: type: integer format: int64 description: Height of the Creative. image_url: type: string description: URL of the image. description: (Will be supported soon) Creative source based on custom html. required: - html - width - height - image_url dspCreativeDynamicHtmlSrc: type: object properties: template_id: type: string description: ID of the template used to render this Creative. template_env: type: object additionalProperties: type: string description: Environment used to render this Creative. rendered_entry_html: type: string description: The entry HTML of the rendered Creative. html_requirement_attributes: $ref: '#/components/schemas/dspCreativeHtmlRequirementAttributes' description: 'Requirements of this Creative. Based on this field and inventory''s excludable Creative attributes, Moloco can filter out this Creative at serving time.' html_size_attributes: $ref: '#/components/schemas/dspCreativeHtmlSizeAttributes' description: Size-related attributes of this Creative. policy: $ref: '#/components/schemas/dspCreativeDynamicHtmlSrcPolicy' description: Policy defines how to select CatalogItems. description: '(Will be supported soon) Dynamic Creative. An instance of this would be used for Creatives to be rendered when the Creative is shown to user, i.e. an impression takes place, unlike bid-time rendering for static images.' required: - template_id - rendered_entry_html dspCreativeDynamicHtmlSrcPolicy: type: object properties: function: $ref: '#/components/schemas/PolicyPolicyFunction' description: 'Algorithm for selecting CatalogItems or CreativeElements for a game. PolicyFunction can be thought of as a function: PolicyFunctionConfig -> Policy -> CatalogItem list. In case a PolicyFunction does not need PolicyFunctionConfig, it can be thought of as Policy -> CatalogItem/CreativeElement list.' function_config: $ref: '#/components/schemas/PolicyPolicyFunctionConfig' num_items: type: integer format: int32 description: Number of items to be selected. catalog: type: string description: Catalog ID. To know the types of catalogs supported, contact customer support. item_capper: $ref: '#/components/schemas/PolicyItemCapper' description: Policy defines how to select CatalogItems. dspCreativeFeature: type: object properties: type: $ref: '#/components/schemas/adcloudcommonCreativeFeatureType' description: CreativeFeatureType. dynamic_creative: $ref: '#/components/schemas/CreativeFeatureDynamicCreative' description: CreativeFeature indicates the feature of the CreativeGroup and its configuration. dspCreativeGroup: type: object properties: id: type: string description: Unique identifier of the CreativeGroup. Automatically set by server on creation. ad_account_id: type: string description: ID of the AdAccount the CreativeGroup belongs to. readOnly: true product_id: type: string description: ID of the Product the CreativeGroup belongs to. readOnly: true title: type: string description: A descriptive name of the CreativeGroup. description: type: string description: An optional description about this CreativeGroup. enabling_state: $ref: '#/components/schemas/commonEnablingState' description: 'Whether this CreativeGroup is enabled by the AdAccount. If this field is unset or set to UNSPECIFIED, the server will change it to ENABLED automatically by default. An active CreativeGroup can be paused at any time by setting this field to DISABLED.' creative_ids: type: array items: type: string description: List of Creative ids in this CreativeGroup. status: $ref: '#/components/schemas/dspCreativeGroupStatus' description: 'The current status of the CreativeGroup. This state is readonly to the client after it gets into a SUBMITTED state. When a new CreativeGroup is created, it will be created in "SUBMITTED" state by default and it requires all the validations to pass. However, the client can specify "DRAFT" as the state in the creation request to request the CreativeGroup be saved as a draft without mandating all the required data. But any user entered data still need to pass their own validation individually for them to be accepted by the Moloco Ads backend. The client can switch a "DRAFT" Creative to "SUBMITTED" by specifying "SUBMITTED" as the state value in an update request later after all required data are entered, and full validation will be invoked on this state switch. After a CreativeGroup gets out of the DRAFT state, the state will be fully managed by the Moloco Ads backend and the state value will become readonly to the client. Any state value specified by the client in the future update requests will be ignored.' action_history: type: array items: type: object $ref: '#/components/schemas/dspCreativeGroupAction' description: List of actions taken on the current Creative. readOnly: true tracking_link_id: type: string description: 'MMP specific impression and click TrackingLinks defined specifically for this CreativeGroup. Optional for CreativeGroup which has APP type Product, not allowed for WEB type Product.' landing_url: type: string description: 'CreativeGroup specific landing URL. Optional for CreativeGroup which has WEB type Product, not allowed for APP type Product.' final_landing_url: type: string description: 'CreativeGroup specific final landing URL. Optional for CreativeGroup which has WEB type Product, not allowed for APP type Product. Deprecated. v1.3 would be the last version supporting this field. Use landing_url field instead.' mmp_tag: type: string description: 'Name of the mmp side reporting tag. mmp_tag should be URL-safe string.' audience: $ref: '#/components/schemas/adclouddspAudience' description: Creative group level audience. feature: $ref: '#/components/schemas/dspCreativeFeature' description: CreativeFeature and its configuration. created_at: type: string format: date-time description: Created time. readOnly: true updated_at: type: string format: date-time description: Last updated time. Should not modify on the client side. publisher_properties: $ref: '#/components/schemas/dspCreativeGroupPublisherProperties' description: CreativeGroup is a group of Creatives that may serve with the same purpose, to be referenced by a Campaign. required: - title dspCreativeGroupAction: type: object properties: id: type: string description: Unique identifier of the Action. Automatically set by server on creation. user_id: type: string description: ID of the user who initiated this action if it's applicable. user_display_name: type: string description: Display name of the user by whom the action was taken. action_type: $ref: '#/components/schemas/CreativeGroupActionType' description: The type of an action. comment: type: string description: Comment for the action. created_at: type: string format: date-time description: Created time. readOnly: true description: The details of an action taken on the CreativeGroup. dspCreativeGroupInactiveReason: type: string enum: - UNKNOWN_REASON - NO_CREATIVE - NO_ADGROUP - SCHEDULED - EXTERNAL_ISSUE - NO_ENABLED_CREATIVE - NO_ENABLED_ADGROUP - NO_ENABLED_CAMPAIGN - DISABLED_CREATIVE_GROUP - ENDED default: UNKNOWN_REASON description: "InActiveReason indicates why the CreativeGroup is not used for bidding.\n\nThis value is not part of the\ \ specification.\n\n - NO_CREATIVE: NO_CREATIVE implies that the CreativeGroup has no Creative.\n - NO_ADGROUP: NO_ADGROUP\ \ implies that the CreativeGroup is not linked to any AdGroup.\n - SCHEDULED: SCHEDULED implies that the CreativeGroup\ \ is scheduled to run at a future day/time.\n - EXTERNAL_ISSUE: EXTERNAL_ISSUE is deprecated.\n - NO_ENABLED_CREATIVE:\ \ NO_ENABLED_CREATIVE implies that the CreativeGroup has no enabled Creative.\nIf a CreativeGroup has NO_CREATIVE\ \ as inactive reasons, NO_ENABLED_CREATIVE won't be included.\n - NO_ENABLED_ADGROUP: NO_ENABLED_ADGROUP implies that\ \ the CreativeGroup is not linked to any enabled AdGroup.\nIf a CreativeGroup has NO_ADGROUP as inactive reasons,\ \ NO_ENABLED_ADGROUP won't be included.\n - NO_ENABLED_CAMPAIGN: NO_ENABLED_CAMPAIGN implies that the CreativeGroup\ \ is not linked to any enabled Campaign.\nIf a CreativeGroup has NO_ADGROUP as inactive reasons, which implies it\ \ doesn't belongs to any campaign too, so NO_ENABLED_CAMPAIGN won't be included.\n - DISABLED_CREATIVE_GROUP: DISABLED_CREATIVE_GROUP\ \ implies that the CreativeGroup's enabling state is set as DISABLED.\n - ENDED: ENDED implies that the CreativeGroup\ \ has passed its schedule end date." dspCreativeGroupOverview: type: object properties: id: type: string description: ID of the CreativeGroup. title: type: string description: Descriptive name of the CreativeGroup. description: type: string description: Optional description about this CreativeGroup. tracking_link_id: type: string description: ID of the TrackingLink used in this CreativeGroup. tracking_link_title: type: string description: Title of the TrackingLink used in this CreativeGroup. landing_url: type: string description: Landing URL used in this CreativeGroup. image_creatives_count: type: integer format: int64 description: Number of image Creatives. video_creatives_count: type: integer format: int64 description: Number of video Creatives. native_creatives_count: type: integer format: int64 description: Number of native Creatives. etc_creatives_count: type: integer format: int64 description: Number of Creatives which are not image, video, native type. enabling_state: $ref: '#/components/schemas/commonEnablingState' description: Enabling state of the CreativeGroup set by user. state: $ref: '#/components/schemas/commonEnablingState' description: 'CreativeGroup''s overall state which represents it''s ready for bidding or not by evaluating it''s related entities. It''s ENABLED if and only if it''s included in the enabled campaign. More details can be found in `inactive_reasons` field if it''s DISABLED.' inactive_reasons: type: array items: $ref: '#/components/schemas/dspCreativeGroupInactiveReason' description: "Inactive reasons of CreativeGroup if the CreativeGroup is not used for bidding.\n\n - NO_CREATIVE:\ \ It implies that the CreativeGroup has no Creative.\n - NO_ADGROUP: It implies that the CreativeGroup is not\ \ linked to any AdGroup.\n - SCHEDULED: It implies that the CreativeGroup is scheduled to run at a future day/time.\n\ \ - NO_ENABLED_CREATIVE: It implies that the CreativeGroup has no enabled Creative. If a CreativeGroup has NO_CREATIVE\ \ as inactive reasons, NO_ENABLED_CREATIVE won't be included.\n - NO_ENABLED_ADGROUP: It implies that the CreativeGroup\ \ is not linked to any enabled AdGroup. If a CreativeGroup has NO_ADGROUP as inactive reasons, NO_ENABLED_ADGROUP\ \ won't be included.\n - NO_ENABLED_CAMPAIGN: It implies that the CreativeGroup is not linked to any enabled Campaign.\ \ If a CreativeGroup has NO_ADGROUP as inactive reasons, which implies it doesn't belongs to any campaign too,\ \ so NO_ENABLED_CAMPAIGN won't be included.\n - DISABLED_CREATIVE_GROUP: It implies that the CreativeGroup's enabling\ \ state is set as DISABLED.\n - ENDED: It implies that the CreativeGroup has passed its schedule end date." creative_group_referrer_infos: type: array items: type: object $ref: '#/components/schemas/dspCreativeGroupReferrerInfo' description: CreativeGroupReferrerInfo is data of the CreativeGroup's relational entities which use the CreativeGroup. feature_type: $ref: '#/components/schemas/adcloudcommonCreativeFeatureType' description: Feature type of the CreativeGroup. created_at: type: string format: date-time description: Created time. readOnly: true updated_at: type: string format: date-time description: Last updated time. Should not modify on the client side. description: 'CreativeGroupOverview is an overview information of CreativeGroup entity. Retrieved when the inquiry_option = INQUIRY_OVERVIEW.' dspCreativeGroupPublisherProperties: type: object properties: skippable: type: boolean title: 'if the field is true, creatives of this group can be skipped. skippable ads reference : https://support.google.com/google-ads/answer/6055025?hl=en' video_target_ad_position: $ref: '#/components/schemas/CreativeVideoSrcTargetAdPosition' description: Target ad position of videos in this group. dspCreativeGroupReferrerInfo: type: object properties: ad_group_id: type: string description: ID of the AdGroup. ad_group_title: type: string description: Title of the AdGroup. ad_group_state: $ref: '#/components/schemas/commonEnablingState' description: EnablingState of the AdGroup. ad_group_experiment_id: type: string description: ID of the Experiment the AdGroup is involved in. campaign_id: type: string description: ID of the Campaign. campaign_title: type: string description: Title of the Campaign. campaign_description: type: string description: Description of the Campaign. campaign_state: $ref: '#/components/schemas/dspCampaignState' description: State of the Campaign. campaign_type: $ref: '#/components/schemas/dspCampaignType' description: Type of the Campaign. campaign_goal: $ref: '#/components/schemas/dspCampaignGoal' description: Goal of the Campaign. campaign_countries: type: array items: type: string description: The countries of the Campaign. campaign_schedule: $ref: '#/components/schemas/commonTimeInterval' description: Schedule of the Campaign. campaign_auto_delete_at: type: string format: date-time description: Auto delete timestamp of the Campaign. description: 'CreativeGroupReferrerInfo is CreativeGroup''s relational data. It contains which Campaign and AdGroup use the CreativeGroup.' dspCreativeGroupStatus: type: string enum: - UNKNOWN_STATUS - DRAFT - SUBMITTED - REVIEW_NOT_NEEDED - UNDER_REVIEW - APPROVED - DISAPPROVED default: UNKNOWN_STATUS description: "Enumeration of all possible CreativeGroup status.\n\n - UNKNOWN_STATUS: This value is not part of the\ \ specification.\n - DRAFT: The CreativeGroup is created but not submitted for review yet.\n - SUBMITTED: The CreativeGroup\ \ is submitted and pending review.\n - REVIEW_NOT_NEEDED: Review is determined by Moloco not needed for this CreativeGroup.\n\ \ - UNDER_REVIEW: The CreativeGroup is being reviewed.\n - APPROVED: The CreativeGroup has been approved.\n - DISAPPROVED:\ \ The CreativeGroup has been rejected." dspCreativeHtmlRequirementAttributes: type: object properties: flags: type: array items: $ref: '#/components/schemas/dspCreativeHtmlRequirementAttributesFlag' description: Flags for describing features that the enclosing Creative requires. use_custom_close: $ref: '#/components/schemas/CreativeHtmlRequirementAttributesCustomCloseType' auto_play_audio: $ref: '#/components/schemas/CreativeHtmlRequirementAttributesAutoPlayAudioType' description: 'Requirements for displaying the Creative. During bidding, Moloco ensures only Creatives with HTML requirements satisfied by the inventory are served.' dspCreativeHtmlRequirementAttributesFlag: type: string enum: - UNKNOWN_FLAG - MRAID2 - IN_BANNER_VIDEO default: UNKNOWN_FLAG description: "This value is not part of the specification.\n\n - MRAID2: AdX: 32 MraidType: MRAID.\n - IN_BANNER_VIDEO:\ \ AdX: 95 VideoType: In-Banner Video (Publisher Blockable)." title: "This is similar to AdX' Creative attributes:\n https://storage.googleapis.com/adx-rtb-dictionaries/buyer-declarable-creative-attributes.txt\n\ Since the purpose of these flags is filtering, we also take into consideration\nwhat inventories can ban:\n https://storage.googleapis.com/adx-rtb-dictionaries/publisher-excludable-creative-attributes.txt" dspCreativeHtmlSizeAttributes: type: object properties: interstitial: type: boolean description: Passes as long as the inventory is for an interstitial ad. fixed: type: array items: type: object $ref: '#/components/schemas/CreativeHtmlSizeAttributesFixed' description: 'Passes as long as the inventory size matches with one of the elements in the list. If the Creative can be rotated, then one should specify both configurations. For non-interstitial ads, at least one dimension is required.' description: 'Size-related attributes for a resizable Creative, such as an HTML-based one. This message acts as a filter condition; if an inventory is matched with the condition in this message, the enclosing Creative passes; i.e., the Creative is not filtered out.' dspCreativeImageSrc: type: object properties: image_url: type: string description: URL of the image. filename: type: string description: Original filename of the image. width: type: integer format: int64 description: Width of the Creative. readOnly: true height: type: integer format: int64 description: Height of the Creative. readOnly: true size_in_bytes: type: integer format: int64 description: Size of the image in bytes. description: "Source of image Creative.\n\nSupported formats: JPEG, PNG, GIF. Maximum file size: 500KB (5MB for GIF).\n\ \nBanner dimensions:\n - 100x21, 300x50, 300x100, 320x48, 320x50, 320x100\n - 360x56, 375x50, 375x59, 392x61, 411x64,\ \ 414x50, 414x65, 468x60\n - 481x56, 640x100, 640x200, 667x56, 711x88, 800x50\n - 970x250, 994x250, 1029x258\n\n\ Full screen dimensions:\n - 300x600, 320x416, 320x480, 320x568, 360x592, 360x604, 360x640\n - 360x718, 360x724,\ \ 360x728, 375x667, 384x787, 412x790, 414x736\n - 428x846, 480x320, 640x360\n\nMedium dimensions:\n - 160x600, 200x200,\ \ 250x250, 300x250, 320x240, 320x267, 336x280, 600x500\n\nTablet dimensions:\n - 728x90, 768x1024, 1024x90, 1024x768,\ \ 1280x90" dspCreativeNativeSrc: type: object properties: icon_image: $ref: '#/components/schemas/dspCreativeImageSrc' description: 'App icon image for the native Creative. Width and height must be equal. Supported formats: JPEG, PNG, GIF. Maximum file size: 500KB (5MB for GIF).' main_image: $ref: '#/components/schemas/dspCreativeImageSrc' description: 'Main image for the native Creative. Supported formats: JPEG, PNG, GIF. Maximum file size: 500KB (5MB for GIF). For native image ads, the following dimensions are supported: - 720x720, 720x960, 720x1280 - 1200x222, 1200x600, 1200x628, 1200x844, 1200x1600 For native video ads, the following dimensions are supported: - 360x480, 360x640, 480x360, 480x480, 640x360 - 720x720, 720x960, 720x1280, 800x418, 1200x628, 1280x720' shrunk_main_image: $ref: '#/components/schemas/dspCreativeImageSrc' description: 'Thumbnail image displayed alongside the native video Creative. Supported formats: JPEG, PNG, GIF. Maximum file size: 500KB (5MB for GIF).' title: type: string description: Title of the native ad. text: type: string description: Text message to show. cta_text: type: string description: Call to action text (e.g. "Get a quote"). sponsored_by: type: string description: Brand name of the sponsor/advertiser. star_rating: type: number format: float description: Star rating value of the app. Value should be in the range of [0, 5]. video: $ref: '#/components/schemas/dspCreativeVideoSrc' description: 'Video asset for native video ads. Only one of the video and vast_video fields may be specified, not both.' vast_video: $ref: '#/components/schemas/dspCreativeVastVideoSrc' description: 'Vast video for native video ads. Only one of the video and vast_video fields may be specified, not both.' description: Source of native Creative. required: - icon_image - main_image - title - text - cta_text dspCreativeOverview: type: object properties: id: type: string description: ID of the Creative. ad_account_id: type: string description: ID of the AdAccount this Creative belongs to. product_id: type: string description: ID of the Product this Creative belongs to. title: type: string description: A descriptive name of the Creative. type: $ref: '#/components/schemas/dspCreativeType' description: Type of the Creative. original_filename: type: string description: Original Creative filename given by user. image: $ref: '#/components/schemas/dspCreativeImageSrc' video: $ref: '#/components/schemas/dspCreativeVideoSrc' vast_video: $ref: '#/components/schemas/dspCreativeVastVideoSrc' native: $ref: '#/components/schemas/dspCreativeNativeSrc' feature_type: $ref: '#/components/schemas/adcloudcommonCreativeFeatureType' description: CreativeFeatureType. creator_tag: type: string description: Creator tag to identify who is the resource creator. created_at: type: string format: date-time description: Created time. updated_at: type: string format: date-time description: Last updated time. Should not modify on the client side. description: 'CreativeOverview is an overview information of Creative entity. It is for the lighter response by omitting some fields and data. Also, it has different behavior for the source field depends on the Creative source type. It doesn''t return source field for the *_HTML Creative types.' dspCreativeReview: type: object properties: id: type: string description: Unique identifier of the CreativeReview. Automatically set by server on creation. creative_groups_using_creative: type: array items: type: object $ref: '#/components/schemas/CreativeReviewCreativeGroupInfo' description: Information of CreativeGroups that are using this Creative. reviews: type: object additionalProperties: $ref: '#/components/schemas/dspCreativeReviewPerExchange' description: Key is the name of the exchange. creative: $ref: '#/components/schemas/dspCreative' description: Creative entity this CreativeReview is based on. description: CreativeReview contains information related to Creatives' review status per exchange. dspCreativeReviewPerExchange: type: object properties: reason_detail: $ref: '#/components/schemas/CreativeReviewPerExchangeReasonDetail' status: $ref: '#/components/schemas/dspCreativeReviewPerExchangeStatus' description: Current approval status of the Creative. action_history: type: array items: type: object $ref: '#/components/schemas/CreativeReviewPerExchangeReviewAction' description: List of actions taken on the current CreativeReview. description: CreativeReviewPerExchange stores review status and review action per exchange. dspCreativeReviewPerExchangeStatus: type: string enum: - UNKNOWN - UNDER_REVIEW - APPROVED - BLOCKED - ETC - APPROVED_FOR_ADULTS - GOOGLE_PLATFORM_APPROVED default: UNKNOWN description: "Enum of each Creative's approval status.\n\nCreative has not been submitted for review.\n\n - UNDER_REVIEW:\ \ Creative is currently under review.\n - APPROVED: Creative has been accepted by the exchange.\n - BLOCKED: Creative\ \ has been rejected by the exchange.\n - ETC: Refer to ReviewAction for more details.\n - APPROVED_FOR_ADULTS: Creative\ \ has been accepted only for adults by the exchange.\n - GOOGLE_PLATFORM_APPROVED: Creative is rejected by ADX (and\ \ ADX_RTB) on network policy but approved on platform policy.\nIn ADX requests, a flag will indicate whether a creative\ \ with this status can bid.\nThis status will only be used in ADX reviews." dspCreativeRichCustomHtmlSrc: type: object properties: entry_html: type: string description: 'The entry HTML code of the Creative. This field is read only. For write purposes, use playable_ad_source instead.' readOnly: true html_requirement_attributes: $ref: '#/components/schemas/dspCreativeHtmlRequirementAttributes' description: 'Requirements of this Creative. Based on this field and inventory''s excludable Creative attributes, Moloco can filter out this Creative.' html_size_attributes: $ref: '#/components/schemas/dspCreativeHtmlSizeAttributes' description: Size-related attributes of this Creative. max_video_duration_seconds: type: integer format: int64 description: 'Max duration of video sources, in seconds. It will be set to 0 if no video source is found in this Creative.' playable_ad_source: $ref: '#/components/schemas/CreativeRichCustomHtmlSrcPlayableADSourceData' description: 'PlayableAD source which is created by the third party like Facbook or Tresensa. For non-playableAD rich_custom_html, it can be left as blank but entryHTML should be filled. This field is available for only creation.' filename: type: string description: The filename of HTML file. description: 'Creative source based on arbitrary HTML. An instance of this is typically used for a playable Creative from AdAccounts. You can create RichCustomHtmlSrc by one of two methods: 1. Upload FB style html file using CreateAssetUploadSession API(PLAYABLE_AD_SOURCE_TYPE_URL) 2. Use Creative template third parties: tresensa or spaceback(PLAYABLE_AD_SOURCE_TYPE_TAG).' required: - html_requirement_attributes dspCreativeTemplateHtmlSrc: type: object properties: template_id: type: string description: ID of the template used to render this Creative. template_env: type: object additionalProperties: type: string description: Environment used to render this Creative. rendered_entry_html: type: string description: The entry HTML of the rendered Creative. html_requirement_attributes: $ref: '#/components/schemas/dspCreativeHtmlRequirementAttributes' description: 'Requirements of this Creative. Based on this field and inventory''s excludable Creative attributes, Moloco can filter out this Creative at serving time.' html_size_attributes: $ref: '#/components/schemas/dspCreativeHtmlSizeAttributes' description: Size-related attributes of this Creative. max_video_duration_seconds: type: integer format: int64 description: Max duration of video sources. Will be 0 if no video source is found in this Creative. description: (Will be supported soon) Creative source based on MRAID template. required: - template_id - rendered_entry_html dspCreativeType: type: string enum: - UNKNOWN_TYPE - IMAGE - VIDEO - VAST_VIDEO - NATIVE - NATIVE_IMAGE - NATIVE_VIDEO - CUSTOM_HTML - TEMPLATE_HTML - RICH_CUSTOM_HTML - DYNAMIC_HTML - AD_TAG default: UNKNOWN_TYPE description: "Type of the Creative. Only one of the Creative source fields matching the type is allowed to be specified.\n\ \n - UNKNOWN_TYPE: This value is not part of the specification.\n - IMAGE: Image Creative. The image Creative source\ \ must be specified for this type.\n - VIDEO: Video Creative. The video Creative source must be specified for this\ \ type.\n - VAST_VIDEO: Vast video Creative. The vast video Creative source must be specified for this type.\n - NATIVE:\ \ Deprecated. v1.5 is the last version supporting this version.\nNative Creative. The native Creative source must\ \ be specified for this type.\n - NATIVE_IMAGE: Native image Creative. The native image Creative source must be specified\ \ for this type.\n - NATIVE_VIDEO: Native video Creative. The native video Creative source must be specified for this\ \ type.\n - CUSTOM_HTML: (Will be supported soon) Custom HTML Creative. The custom HTML Creative source must be specified\ \ for this type.\n - TEMPLATE_HTML: (Will be supported soon) Template HTML Creative. The template HTML Creative source\ \ must be specified for this type.\n - RICH_CUSTOM_HTML: The rich custom HTML Creative. The rich custom HTML Creative\ \ source must be specified for this type.\n - DYNAMIC_HTML: (Will be supported soon) The dynamic HTML Creative. The\ \ dynamic HTML Creative source must be specified for this type.\n - AD_TAG: (Will be supported soon) Third-party ad\ \ tag Creative with script-based or vast tag-based ad tag." dspCreativeVastVideoSrc: type: object properties: vast_tag: type: string description: 'VAST tag to be used in VAST wrapper. E.g. [Example here](https://github.com/InteractiveAdvertisingBureau/VAST_Samples/blob/master/VAST%201-2.0%20Samples/Tremor-Video-Samples/vast_wrapper_linear_1.xml).' width: type: integer format: int64 description: Width of the Creative. readOnly: true height: type: integer format: int64 description: Height of the Creative. readOnly: true length_seconds: type: integer format: int64 description: Vast video length in seconds. description: Source of VAST (Video Ad Serving Template) video Creative. required: - vast_tag dspCreativeVideoSrc: type: object properties: video_url: type: string description: URL of the video media. Currently we support only mp4 format. filename: type: string description: Original filename of the video. width: type: integer format: int64 description: Width of the Creative. height: type: integer format: int64 description: Height of the Creative. length_seconds: type: integer format: int64 description: Video length in seconds. fps: type: integer format: int64 description: Number of frames per second for the video. size_in_bytes: type: integer format: int64 description: Size of the video in bytes. Note it doesn't include the bytes for the companion images. companion_images: type: array items: type: object $ref: '#/components/schemas/dspCreativeImageSrc' description: 'Endcard image shown after video play ends. The orientation must match the video orientation. Supported formats: JPEG, PNG, GIF. Maximum file size: 500KB (5MB for GIF).' auto_endcard: type: boolean description: Whether the endcard is generated automatically by MCP or manually uploaded by the user. playable_endcard: $ref: '#/components/schemas/dspCreativeRichCustomHtmlSrc' description: 'HTML-based playable endcard that is shown after video play is ended. Either a playable or an image (via `companion_images`) or a dynamic html (via `dynamic_html_endcard`) must be used.' dynamic_html_endcard: $ref: '#/components/schemas/dspCreativeDynamicHtmlSrc' description: 'HTML-based dynamic html endcard that is shown after video play is ended. Either a dynamic html or an image (via `companion_images`) or a playable (via `playable_endcard`) must be used.' transcoding_info: $ref: '#/components/schemas/CreativeVideoSrcTranscodingInfo' description: Transcoding information of the video. readOnly: true description: 'Source of video Creative. Supported format: MP4. Maximum file size: 300MB (before transcoding). At least one of width or height must be ≥ 640px. Duration: 6–180 seconds.' required: - video_url - width - height - length_seconds dspCustomerActivity: type: object properties: id: type: string description: 'The server generated random unique identifier of the CustomerActivity. (Required/Immutable).' title: type: string description: 'The human readable short name. (Required/Mutable).' description: type: string description: 'The description about the CustomerActivity. (Optional/Mutable).' include_having_all: type: array items: type: object $ref: '#/components/schemas/CustomerActivityActivityCondition' description: This condition will include a customer only if all of the listed activity conditions are satisfied. include_having_any: type: array items: type: object $ref: '#/components/schemas/CustomerActivityActivityCondition' description: This condition will include a customer if at least one condition from the listed activity conditions is satisfied. exclude_having_all: type: array items: type: object $ref: '#/components/schemas/CustomerActivityActivityCondition' description: This condition will exclude a customer only if all of the listed activity conditions are satisfied.. exclude_having_any: type: array items: type: object $ref: '#/components/schemas/CustomerActivityActivityCondition' description: This condition will exclude a customer if at least one condition from the listed activity conditions is satisfied. created_at: type: string format: date-time updated_at: type: string format: date-time description: 'CustomerActivity represents a group of target customers to whom we''re going to show an ad. CustomerActivity determines a dynamic (not pre-determined) set of target customers based on App-events described in the postback messages. (e.g. purchase, close, open, etc.).' dspCustomerSet: type: object properties: id: type: string description: Unique identifier of the CustomerSet. Automatically set by server on creation. title: type: string description: A descriptive name of the CustomerSet. description: type: string description: An optional description of the CustomerSet. id_type: $ref: '#/components/schemas/dspCustomerSetIdType' description: Type of user identifiers of this CustomerSet. status: $ref: '#/components/schemas/dspCustomerSetStatus' data_file_path: type: string description: "Data source path of users.\nex) gcs path for txt file of specific-type user lists (query result for\ \ postback, or journal...).\n\nAPPLE_IDFA user list txt file example: (one idfa per line).\n ______________________________________\n\ 8a05cce7-da5c-4980-8cef-2603ae1742b6\nffffffff-ffff-4fff-8fff-ffffffffffff" is_upper: type: boolean description: A flag indicating that identifiers are upper-cased. False if they are lower-cased. auto_delete_at: type: string format: date-time description: 'CustomerSet used nowhere for specific time will be removed automatically. It represents when this will be deleted in UTC.' readOnly: true created_at: type: string format: date-time description: Created time. readOnly: true updated_at: type: string format: date-time description: Last updated time. Should not modify on the client side. recent_file_update_info: $ref: '#/components/schemas/CustomerSetFileUpdateInfo' description: Most recent update info. readOnly: true status_detail: $ref: '#/components/schemas/CustomerSetCustomerSetStatusDetail' file_update_histories: type: array items: type: object $ref: '#/components/schemas/CustomerSetFileUpdateHistory' title: 'Maximum # of histories: 10' readOnly: true description: 'CustomerSet represents a group of user identifiers can be used in Moloco Ads. (e.g. Targeting, Audience Lift model generation and so on).' required: - title - id_type - data_file_path dspCustomerSetIdType: type: string enum: - UNKNOWN_ID_TYPE - GOOGLE_ADID - APPLE_IDFA default: UNKNOWN_ID_TYPE description: " - UNKNOWN_ID_TYPE: Unknown user ID type.\n - GOOGLE_ADID: Google Android advertising ID type.\n - APPLE_IDFA:\ \ Apple iOS advertising ID type." dspCustomerSetStatus: type: string enum: - UNKNOWN_STATUS - PREPARING - READY - FAILED default: UNKNOWN_STATUS description: "Unknown status.\n\n - PREPARING: Premature status.\n - READY: Ready.\n - FAILED: Failed to be ready." dspDailyBudgetSchedule: type: object properties: daily_budget: $ref: '#/components/schemas/adcloudcommonMoney' description: Daily budget in Campaign's currency. Daily spending resets at 12am UTC every day. dspDayOfWeekBudgetSchedule: type: object properties: monday_budget: $ref: '#/components/schemas/adcloudcommonMoney' tuesday_budget: $ref: '#/components/schemas/adcloudcommonMoney' wednesday_budget: $ref: '#/components/schemas/adcloudcommonMoney' thursday_budget: $ref: '#/components/schemas/adcloudcommonMoney' friday_budget: $ref: '#/components/schemas/adcloudcommonMoney' saturday_budget: $ref: '#/components/schemas/adcloudcommonMoney' sunday_budget: $ref: '#/components/schemas/adcloudcommonMoney' description: Budget for each day of the week; all 7-day budgets need be filled for use. dspEntityCount: type: object properties: scope_type: $ref: '#/components/schemas/commonEntityType' description: Scope of the EntityCount. limit: type: string format: int64 description: 'The total number of entities allowed under the scope type. ''limit'' for the entity is different for each scope type. Visit the [guide document](https://developer.moloco.cloud/docs/entity-quota) for more details.' current: type: string format: int64 description: The number of entities created so far. description: EntityCount contains the limit and the number of the entities under the particular scope. dspInAppEventCondition: type: object properties: attribution: $ref: '#/components/schemas/InAppEventConditionAttribution' revenue: $ref: '#/components/schemas/InAppEventConditionRevenue' time_window: $ref: '#/components/schemas/InAppEventConditionTimeWindow' dspLog: type: object example: id: sampleLogId ad_account_id: sampleAdAccountId type: IMP format: CSV date: '2020-01-01' created_at: '2020-01-03T03:12:50.124101982Z' updated_at: '2020-01-03T03:24:21.109821241Z' properties: id: type: string description: Unique identifier of the Log. Automatically set by server on creation. type: $ref: '#/components/schemas/dspLogType' description: Type of data which a log contains. format: $ref: '#/components/schemas/dspLogFormat' description: Format of generated log files. date: type: string description: Date for which a log contains the data in "yyyy-mm-dd" format. ad_account_id: type: string description: Ad account ID to which the log is bound. status: $ref: '#/components/schemas/dspLogStatus' description: Status of the log generation. readOnly: true skip_compression: type: boolean description: Flag whether to skip compression. expire_at: type: string format: date-time description: The time when a log will be expired. readOnly: true created_at: type: string format: date-time description: Created time. readOnly: true updated_at: type: string format: date-time description: Last updated time. Should not modify on the client side. description: The metadata of a log. required: - type - date - ad_account_id dspLogFormat: type: string enum: - UNKNOWN_LOG_FORMAT - CSV - AVRO - PARQUET default: UNKNOWN_LOG_FORMAT description: "Format enumerates the format of log. Default is CSV.\n\n - CSV: CSV format.\n - AVRO: Avro format.\n -\ \ PARQUET: Parquet format." dspLogStatus: type: string enum: - UNKNOWN_LOG_STATUS - ACCEPTED - READY - FAILED default: UNKNOWN_LOG_STATUS description: "Status enumerates the status of log.\n\n - ACCEPTED: Successfully initiated the log generation request.\n\ \ - READY: Successfully generated the log. It's ready to download from the location.\n - FAILED: Failed to generate\ \ the log. Reasons of failure can be found at errors." dspLogType: type: string enum: - UNKNOWN_LOG_TYPE - IMP - CLICK - CONVERSION - SKAN_CONVERSION - ENGAGED_VIEW default: UNKNOWN_LOG_TYPE description: "Type enumerates available log types.\n\nUnknown log type.\n\n - IMP: Log type which includes every impression\ \ log.\n - CLICK: Log type which includes every click log.\n - CONVERSION: Log type which includes every conversion\ \ event log.\n - SKAN_CONVERSION: Log type which includes SKAdNetwork attributed conversion event log.\n - ENGAGED_VIEW:\ \ Log type which includes every engaged view log." dspMmpIntegration: type: object properties: id: type: string description: The unique identifier of the MmpIntegration. mmp_bundle_id: type: string description: Exact key which is used in MMP. mmp: $ref: '#/components/schemas/adcloudcommonTrackingCompany' description: MMP (e.g., Appsflyer, MAT, and so on). ownership: type: boolean description: Whether the Product's AdAccount has ownership for the MmpIntegration. readOnly: true status: $ref: '#/components/schemas/dspMmpIntegrationStatus' description: Current status of this IntegrationID. denied_reason: type: string description: Review denied reason if its status is DENIED. cv_config_item: $ref: '#/components/schemas/MmpIntegrationConversionValueConfigurationItem' description: Conversion value configuration setting. mmp_context: $ref: '#/components/schemas/MmpIntegrationMmpContext' description: Stores MMP-specific contextual data. updated_at: type: string format: date-time description: Last updated time. Should not modify on the client side. allow_fingerprinting: type: boolean description: Whether the app owner has allowed the MMP's fingerprinting for attributions. fingerprinting_last_auto_refreshed_at: type: string format: date-time description: Timestamp for last update of "allow_fingerprinting". readOnly: true description: MmpIntegration represents the MMP integration information. dspMmpIntegrationStatus: type: string enum: - UNKNOWN_STATUS - UNDER_REVIEW - DENIED - ACTIVE default: UNKNOWN_STATUS dspPostbackIntegration: type: object properties: mmp: $ref: '#/components/schemas/adcloudcommonTrackingCompany' description: MMP (e.g., Appsflyer, MAT, and so on). bundle_id: type: string description: "bundle_id to be used in the MMP integration. This corresponds to app_bundle in postback table.\nWe've\ \ relied on the identifier sent by the tracker to keep track of events in our internal database.\nWhen we want\ \ to target to the audience of a Campaign, we need to exactly specify the identifier in the\ntarget description.\ \ Unfortunately, it depends on tracker's policy especially for iOS app as follows:\n - Appsflyer: \"id\" + NUMBER,\ \ where NUMBER is app bundle.\n - Tune: independent string to NUMBER.\n e.g., memebox is denoted as\ \ \"com.memebox.ios.memebox\" while app bundle is 896990789\n - Adjust: same with the app_bundle\n - trackfnt:\ \ same with the app_bundle\nNote that 'bundle' field will be used as tracking bundle if 'tracking_bundle' is not\ \ given. In many\ncase, this field can be filled after we receive the very first event from tracker for an app." description: PostbackIntegration represents the postback integration information. dspPostbackIntegrationEventSummary: type: object properties: summary: type: array items: type: object $ref: '#/components/schemas/PostbackIntegrationEventSummaryEventTypeSummary' last_modified_at: type: string format: date-time dspPostbackIntegrationStatus: type: object properties: device_os: $ref: '#/components/schemas/commonDeviceOs' description: The device OS of the postback integration. country: type: string description: 'Country to which the postback is integrated with. The field should conform to [ISO-3166-1 Alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) format e.g. "KOR", "USA". It is used for filtering bid requests by country name.' complete_percentage: type: number format: double description: Integration completion percentage per each country. integration_success: type: boolean description: The flag that specifies the integration is completed in any country. dspProduct: type: object properties: id: type: string description: Unique identifier of the Product. Automatically set by server on creation. ad_account_id: type: string description: The ID of the AdAccount the Product belongs to. readOnly: true title: type: string description: A descriptive name of the Product. description: type: string description: A short description of the Product. advertiser_domain: type: string description: 'Advertiser domain (e.g., "ford.com"). Usually the domain of AdAccounts''s web page. From v1.7.4, it should be non empty if the value of allow_empty_advertiser_domain is false. If the value is empty, some exchanges may deny campaigns under the product.' allow_empty_advertiser_domain: type: boolean description: 'A flag to allow empty value of advertiser_domain. Setting this flag to true acknowledges that some exchanges may deny campaigns if the advertiser_domain is empty. From v1.7.4, the value should be true if the value of advertiser_domain is empty.' device_os: $ref: '#/components/schemas/commonDeviceOs' description: Device OS of the Product. It means that the OS of the device where the Campaign of this Product is provided. developer_name: type: string description: 'The developer name of the Product. Some publishers request the sponsor information for the native Creative. The value of developer_name will be used to fill that information. Please note that this value could be displayed on user''s screen. If this field is empty, native Creative''s title will be used.' type: $ref: '#/components/schemas/dspProductType' description: The type of the Product. app: $ref: '#/components/schemas/ProductAppProperties' description: Required for APP type. web: $ref: '#/components/schemas/ProductWebProperties' description: Required for WEB type. dynamic_creative_property: $ref: '#/components/schemas/ProductDynamicCreativeProperty' description: Properties for using dynamic Creative. Immutable. suspension_history: type: array items: type: object $ref: '#/components/schemas/ProductSuspensionAction' description: 'List of suspension actions. It is sorted by timestamp in descending order, so the first one is the current suspension result.' readOnly: true created_at: type: string format: date-time description: Created time. readOnly: true updated_at: type: string format: date-time description: Last updated time. Should not modify on the client side. readOnly: true description: 'Product represents an app (per device OS) or a website that an AdAccount want to promote with a Campaign. A Campaign should be associated with a single Product.' required: - type - title - advertiser_domain dspProductType: type: string enum: - UNKNOWN_TYPE - APP - WEB default: UNKNOWN_TYPE description: "Product type.\n\n - UNKNOWN_TYPE: This value is not part of the specification.\n - APP: App type.\n -\ \ WEB: Web type." dspReadCreativeGroupOverview: type: object properties: creative_group: $ref: '#/components/schemas/dspCreativeGroup' description: The retrieved CreativeGroup. state: $ref: '#/components/schemas/commonEnablingState' description: 'State of the CreativeGroup. Enabled state means that the CreativeGroup is used for bidding.' inactive_reasons: type: array items: $ref: '#/components/schemas/dspCreativeGroupInactiveReason' description: "Inactive reasons of CreativeGroup if the CreativeGroup is not used for bidding.\n\n - NO_CREATIVE:\ \ It implies that the CreativeGroup has no Creative.\n - NO_ADGROUP: It implies that the CreativeGroup is not\ \ linked to any AdGroup.\n - SCHEDULED: It implies that the CreativeGroup is scheduled to run at a future day/time.\n\ \ - NO_ENABLED_CREATIVE: It implies that the CreativeGroup has no enabled Creative. If a CreativeGroup has NO_CREATIVE\ \ as inactive reasons, NO_ENABLED_CREATIVE won't be included.\n - NO_ENABLED_ADGROUP: It implies that the CreativeGroup\ \ is not linked to any enabled AdGroup. If a CreativeGroup has NO_ADGROUP as inactive reasons, NO_ENABLED_ADGROUP\ \ won't be included.\n - NO_ENABLED_CAMPAIGN: It implies that the CreativeGroup is not linked to any enabled Campaign.\ \ If a CreativeGroup has NO_ADGROUP as inactive reasons, which implies it doesn't belongs to any campaign too,\ \ so NO_ENABLED_CAMPAIGN won't be included.\n - DISABLED_CREATIVE_GROUP: It implies that the CreativeGroup's enabling\ \ state is set as DISABLED.\n - ENDED: It implies that the CreativeGroup has passed its schedule end date." creative_group_referrer_infos: type: array items: type: object $ref: '#/components/schemas/dspCreativeGroupReferrerInfo' description: CreativeGroupReferrerInfo is data of the CreativeGroup's relational entities which use the CreativeGroup. description: 'ReadCreativeGroupOverview is an overview information of CreativeGroup entity. Retrieved when the inquiry_option = INQUIRY_OVERVIEW.' dspReport: type: object example: id: sampleReportId ad_account_id: sampleAdAccountId date_range: start: '2020-01-01' end: '2020-01-02' dimensions: - DATE - APP_OR_SITE - CAMPAIGN created_at: '2020-01-03T03:12:50.124101982Z' updated_at: '2020-01-03T03:24:21.109821241Z' properties: id: type: string description: Unique identifier of the Report. Automatically set by server on creation. ad_account_id: type: string description: Ad account ID to which the report associated. product_id: type: string description: Product App or Site ID to which the report associated. date_range: $ref: '#/components/schemas/adcloudcommonDateInterval' description: 'Date range for which the report contains the statistical data. Both start and end date are inclusive.' dimensions: type: array items: $ref: '#/components/schemas/dspReportDimension' description: List of interested dimensions by which metric numbers will be broken down. optional_metrics: type: array items: $ref: '#/components/schemas/ReportOptionalMetric' description: List of interested optional metrics. expire_at: type: string format: date-time description: The time when a report will be expired. created_at: type: string format: date-time description: Created time. readOnly: true updated_at: type: string format: date-time description: Last updated time. Should not modify on the client side. description: The metadata of a report. required: - date_range - dimensions - ad_account_id dspReportDimension: type: string enum: - UNKNOWN_REPORT_DIMENSION - DATE - APP_OR_SITE - CAMPAIGN - AD_GROUP - CREATIVE_GROUP - CREATIVE - EXCHANGE - SUB_PUBLISHER - TRAFFIC - SKAN default: UNKNOWN_REPORT_DIMENSION description: Dimension enumerates available breakdown dimensions. dspReportExport: type: object example: id: sampleReportExportId badge: sampleReportExportId#AdAccount:sampleAdAccountId#App:sampleAppId workplace_id: samplePlatformId ad_account_id: sampleAdAccountId product_id: sampleAppId partner: SINGULAR created_at: '2020-01-03T03:12:50.124101982Z' updated_at: '2020-01-03T03:24:21.109821241Z' properties: id: type: string description: Unique identifier of the ReportExport. Automatically set by server on creation. badge: type: string description: Server generated, user-friendly ReportExport identifier for partner integration. readOnly: true workplace_id: type: string description: Workplace ID to which the ReportExport associated. ad_account_id: type: string description: Ad account ID to which the ReportExport associated. product_id: type: string description: Product ID to which the ReportExport associated. partner: $ref: '#/components/schemas/ReportExportPartner' description: Partner is a report partner to export. created_at: type: string format: date-time description: Created time. readOnly: true updated_at: type: string format: date-time description: Last updated time. Should not modify on the client side. description: ReportExport is the metadata for the report export. required: - partner - workplace_id - ad_account_id - product_id dspReportFilterDimension: type: string enum: - UNKNOWN_REPORT_FILTER_DIMENSION - Product_ID - Campaign_ID - AdGroup_ID - Creative_ID - Creative_Type - SubPublisher_ID - SubPublisher_Type - Inventory_Type - Exchange_ID - Product_OS - Campaign_Country - Campaign_IsLAT - Campaign_Type - CreativeGroup_ID - Campaign_BidCountry - Campaign_GoalType - Creative_VideoEndCardType - Device_RegionCode - Campaign_IsCrossPromo default: UNKNOWN_REPORT_FILTER_DIMENSION description: ReportFilterDimension enumerates available breakdown dimensions. dspRole: type: object properties: type: $ref: '#/components/schemas/dspRoleType' description: The role types users can have. workplace_id: type: string description: The workplace bound to the role. ad_account_id: type: string description: The ad account id bound to role. exchange_id: type: string description: The exchange id bound to role. description: 'Role that user can have. Role is bound to resource.' dspRoleType: type: string enum: - WORKPLACE_OWNER - AD_ACCOUNT_OWNER - AD_ACCOUNT_MEMBER - AD_ACCOUNT_VIEWER default: UNKNOWN_TYPE description: " - WORKPLACE_OWNER: Workplace owner represents a user who can do anything in a given workplace.\n - AD_ACCOUNT_OWNER:\ \ Ad account owner represents a user who can do anything in a given ad account.\n - AD_ACCOUNT_MEMBER: Ad account\ \ member can view all users of the Ad Account.\nCan invite new users as Ad Account Member or Ad Account Viewer\nCan\ \ edit your own information (ex: name)\nCan create and edit ad campaigns\n - AD_ACCOUNT_VIEWER: Ad account Viewer\ \ role offers a limited set of permissions that allows users\nonly to read the basic information of the resources." dspSKAdNetworkInput: type: object properties: targeting_state: $ref: '#/components/schemas/SKAdNetworkInputTargetingState' description: Targeting state w.r.t SKAdNetwork traffic. include_traffic_without_attributions: type: boolean description: 'It adds SKAN_CUSTOM_OPTION_NON_ATTRIBUTABLE to target traffic. It is only effective when the targeting_state is ''TARGET_ALL'' or ''TARGET_SKADN_ONLY''.' custom_options: type: array items: $ref: '#/components/schemas/SKAdNetworkInputCustomOption' description: 'custom_options hold all the traffic the Campaign want to target. It is only effective when the targeting_state is ''TARGET_CUSTOM''.' prefer_mmp_attribution: type: boolean description: '1) targeting_state is TARGET_NON_SKADN_ONLY 2) targeting_state is TARGET_CUSTOM and custom_options is set exclusively to SKAN_CUSTOM_OPTION_BI_ATTRIBUTABLE. If true, the Campaign skips SKAN allocation.' title: 'prefer_mmp_attribution indicates whether the Campaign prefers MMP attribution when both MMP and SKAdNetwork attributions are available. It is valid only in the following cases:' description: 'SKAdNetworkInput represents various configurations w.r.t SKAdNetwork traffic. It''s meaningful only for IOS. Use case in MCP: https://help.moloco.com/hc/en-us/articles/1500005837321-SKAdNetwork-Campaign-Settings.' dspSharedAudienceTarget: type: object properties: id: type: string description: ID of the SharedAudienceTarget. Automatically set by server on creation. title: type: string description: A descriptive name of the SharedAudienceTarget. targeting_condition: $ref: '#/components/schemas/dspAudienceTargetingCondition' aud_size: type: string format: int64 description: Original audience size information. readOnly: true reachable_aud_size: type: string format: int64 description: Reachable audience size information. readOnly: true top_n_countries_aud_size_map: type: object additionalProperties: type: string format: int64 description: Top N countries audience size information. readOnly: true last_aud_size_computed_at: type: string format: date-time description: Last updated time of the audience size information. readOnly: true auto_delete_at: type: string format: date-time description: 'AudienceTarget used nowhere for specific time will be removed automatically. It represents when this will be deleted in UTC.' readOnly: true created_at: type: string format: date-time description: Created time. readOnly: true updated_at: type: string format: date-time description: Last updated time. Should not modify on the client side. description: 'SharedAudienceTarget represents a persisted AudienceTargetingCondition that can be shared across multiple Campaigns. It can be referenced by ID by other objects, e.g. the Audience object.' required: - title dspTrackingLink: type: object properties: id: type: string description: Unique identifier of the TrackingLink. Automatically set by server on creation. ad_account_id: type: string description: The ID of the AdAccount the TrackingLink belongs to. readOnly: true product_id: type: string description: The ID of the Product the TrackingLink belongs to. readOnly: true title: type: string description: A descriptive name of the TrackingLink. description: type: string description: An optional description about the TrackingLink. device_os: $ref: '#/components/schemas/commonDeviceOs' description: Device OS for which this TrackingLink should be served. click_through_link: $ref: '#/components/schemas/TrackingLinkUrlData' description: Click-through landing page URL. This URL is usually provided by the tracking company. view_through_link: $ref: '#/components/schemas/TrackingLinkUrlData' description: View-through impression tracking URL. This URL is usually provided by the tracking company. ctv_adjust_dual_vt_link: $ref: '#/components/schemas/TrackingLinkUrlData' title: This is used only for DSP CTV with adjust supporting dual link solution in s2s manner tracking_company: $ref: '#/components/schemas/adcloudcommonTrackingCompany' description: Tracking company (e.g., Appsflyer, MAT, and so on). created_at: type: string format: date-time description: Created time. readOnly: true updated_at: type: string format: date-time description: Last updated time. Should not modify on the client side. description: TrackingLink represents an AdAccount's configuration for. required: - device_os - click_through_link - title dspTrackingLinkOverview: type: object properties: id: type: string description: ID of the TrackingLink. title: type: string description: Descriptive name of the TrackingLink. description: type: string description: An optional description about the TrackingLink. product_id: type: string description: ID of the Product that this TrackingLink belongs to. product_title: type: string description: Title of the Product that this TrackingLink belongs to. tracking_company: $ref: '#/components/schemas/adcloudcommonTrackingCompany' description: Tracking company (e.g., Appsflyer, MAT, and so on). attempts: type: array items: type: object $ref: '#/components/schemas/dspTrackingLinkVerificationAttempt' description: The TrackingLink verification attempts related with the TrackingLink. description: TrackingLinkOverview is a overview information of TrackingLink entity. dspTrackingLinkVerificationAttempt: type: object properties: id: type: string description: The ID of the TrackingLinkVerificationAttempt. ad_account_id: type: string description: The AdAccount ID that this attempt belongs to. tracking_link_id: type: string description: The ID of the TrackingLink that this attempt belongs to. url_data_type: $ref: '#/components/schemas/TrackingLinkVerificationAttemptUrlDataType' user_id: type: string description: The ID of the user who is conducting the link verification. user_email: type: string description: The user's email. user_name: type: string description: The user's name. tracking_bundle_id: type: string description: The tracking bundle value appears at the postback event. resolved_url: type: string description: 'The URL sent to the MMP for the verification test. This is the macro expansion result of the original link URL.' resolved_idfa: type: string description: The IDFA value used to generate the resolved_url. started_at: type: string format: date-time description: The starting time of the verification. verified_at: type: string format: date-time description: The time when the verification test is completed. description: TrackingLinkVerificationAttempt represents an attempt to verify a TrackingLink. dspUser: type: object properties: email: type: string description: Email of User. Immutable. id: type: string description: ID of User. Immutable. name: type: string description: First name of the User. last_name: type: string description: Last name of the User. company_name: type: string description: Company name of the User. terms_agreed: type: boolean description: Whether the user agreed to terms and privacy policy. marketing_agreed: type: boolean description: Whether the user agreed to receive marketing purpose informations. locale: $ref: '#/components/schemas/commonLocale' description: The locale preference of the user. created_at: type: string format: date-time description: The time when a user was created. readOnly: true updated_at: type: string format: date-time description: The time when a user was updated. readOnly: true description: User represents a single user. dspWeeklyFlexibleBudgetSchedule: type: object properties: weekly_budget: $ref: '#/components/schemas/adcloudcommonMoney' description: Weekly budget in Campaign's currency. dspWorkplace: type: object properties: id: type: string description: The workplace ID. title: type: string description: The workplace title. logo_url: type: string description: The URL of the workplace logo image file. configuration: type: object additionalProperties: type: string description: The workplace's configuration. description: The workplace. dspWorkplaceCreationRequest: type: object properties: id: type: string description: Unique identifier for request. company_info: $ref: '#/components/schemas/dspCompanyInfo' description: Company info for th requested workplace. status: $ref: '#/components/schemas/dspWorkplaceCreationRequestStatus' description: Status of the request. reject_reason: type: string description: Rejected reason in case request is rejected. requested_at: type: string format: date-time description: Requested time. workplace_id: type: string description: 'Created workplace''s ID after finalized. Only visible when request is approved.' workplace_title: type: string description: Title of the workplace. ad_account_info: $ref: '#/components/schemas/dspWorkplaceCreationRequestAdAccountInfo' description: AdAccount information used to create a default AdAccount for the Workplace. dspWorkplaceCreationRequestAdAccountInfo: type: object properties: timezone: type: string description: '[IANA timezone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) name. e.g. America/Los_Angeles.' currency: $ref: '#/components/schemas/adcloudcommonCurrency' dspWorkplaceCreationRequestStatus: type: string enum: - WORKPLACE_CREATION_REQUEST_UNKNOWN - WORKPLACE_CREATION_REQUEST_PENDING - WORKPLACE_CREATION_REQUEST_APPROVED - WORKPLACE_CREATION_REQUEST_REJECTED - WORKPLACE_CREATION_REQUEST_FAILED default: WORKPLACE_CREATION_REQUEST_UNKNOWN dspWorkplaceHistory: type: object properties: workplace_creation_requests: type: array items: type: object $ref: '#/components/schemas/dspWorkplaceCreationRequest' dspWorkplaceSummaryRow: type: object properties: date_start: type: string description: 'Start date of the month in the "YYYY-MM-DD" format. Except for the first month of the contract, the date is the 1st of the month.' date_end: type: string description: 'End date of the month in the "YYYY-MM-DD" format. Except for the current month or the contract''s last month, the date is the last day of the month.' spend: $ref: '#/components/schemas/adcloudcommonMoney' description: 'Total ad spend in the contract Workplace currency. This value is the amount before the discount is applied.' discount: $ref: '#/components/schemas/adcloudcommonMoney' description: Discount amount based on the contract pricing plan of the month. description: A row in the Workplace summary table consisting of columns. dspWorkplaceWithInvitation: type: object properties: workplace: $ref: '#/components/schemas/dspWorkplace' description: The workplace. requested_invitation: type: boolean description: Whether user requested an invitation to this workplace. requested_at: type: string format: date-time description: Requested time. description: The workplace with invitation status. dspmessagesTokenType: type: string enum: - UNKNOWN_TYPE - AUTH_TOKEN - UPDATE_PASSWORD_TOKEN default: UNKNOWN_TYPE description: "TokenType enumerates the type of token.\n\n - AUTH_TOKEN: Token returned on the authentication success.\n\ \ - UPDATE_PASSWORD_TOKEN: If user didn't update password for over 12 months, it will return `UPDATE_PASSWORD_TOKEN`.\n\ This token can be only used for [UpdatePassword API](https://developer.moloco.cloud/reference/dspapi_updatepassword-1).\n\ https://developer.moloco.cloud/reference/dspapi_updatepassword-1" googlerpcStatus: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/protobufAny' messagesCampaignInput: type: object properties: campaign: $ref: '#/components/schemas/dspCampaign' description: The Campaign to create. ad_group: $ref: '#/components/schemas/dspAdGroup' description: Deprecated. Use AdGroups instead. readOnly: true ad_groups: type: array items: type: object $ref: '#/components/schemas/dspAdGroup' description: The initial AdGroups of the creating Campaign. required: - campaign messagesCompleteSignupError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesCompleteSignupErrorAPIErrorInfo' messagesCompleteSignupErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesCompleteSignupErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesCompleteSignupErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN - USER_INVALID_PASSWORD - USER_TERMS_AGREEMENT_REQUIRED_TO_SIGN_UP - USER_ALREADY_SIGNUP - USER_ALREADY_SET_PASSWORD_USING_TOKEN default: ERROR_REASON_UNKNOWN description: " - USER_INVALID_PASSWORD: User password is invalid.\nPassword must be at least 12 characters and contain\ \ at least one number, uppercase letter, lowercase letter and special character.\n - USER_TERMS_AGREEMENT_REQUIRED_TO_SIGN_UP:\ \ User must agree to terms and privacy policy to sign up.\n - USER_ALREADY_SIGNUP: The user has already signed up.\n\ \ - USER_ALREADY_SET_PASSWORD_USING_TOKEN: The user has already set their password using token." messagesCompleteSignupRequest: type: object properties: user: $ref: '#/components/schemas/dspUser' description: The User data to be created. password: type: string description: 'The password that user want to create. Required for password based login users. Password must be at least 12 characters and contain at least one number, uppercase letter, lowercase letter and special character.' required: - user messagesCompleteSignupResponse: type: object properties: user: $ref: '#/components/schemas/dspUser' description: The user. messagesCopyCreativeGroupsSyncRequest: type: object properties: ad_account_id: type: string description: The ID of the AdAccount. creative_group_ids: type: array items: type: string description: The list of ids of CreativeGroups to be copied. source_product_id: type: string description: The ID of the source Product. target_product_id: type: string description: The ID of the target Product. target_trackinglink_ids: type: array items: type: string description: 'The ID of the target Product trackinglinks the new CreativeGroups will use. Required for CreativeGroups which have APP type Product, not allowed for those which have WEB type Product. Specify ID of repeated ids as empty string if the CreativeGroup to be copied does not need TrackingLink. Each element of this field is matched to the entry of same index of creative_group_ids.' target_landing_urls: type: array items: type: string description: 'The landing URL of the new CreativeGroups will use. Required for CreativeGroups which have WEB type Product, not allowed for those which have APP type Product. Specify ID of repeated ids as empty string if the CreativeGroup to be copied does not need landing url. Each element of this field is matched to the entry of same index of creative_group_ids.' required: - ad_account_id - creative_group_ids - source_product_id - target_product_id messagesCopyCreativeGroupsSyncResponse: type: object properties: succeed_creative_group_ids: type: array items: type: string description: The list of ids of source CreativeGroups that successfully copied. failed_logs: type: array items: type: object $ref: '#/components/schemas/CopyCreativeGroupsSyncResponseCopyCreativeGroupsSyncFailedLog' description: The log list of failed CreativeGroup ID and reason. messagesCopyCreativesSyncError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesCopyCreativesSyncErrorAPIErrorInfo' messagesCopyCreativesSyncErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesCopyCreativesSyncErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesCopyCreativesSyncErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN default: ERROR_REASON_UNKNOWN messagesCopyCreativesSyncRequest: type: object properties: ad_account_id: type: string description: The ID of the AdAccount. creative_ids: type: array items: type: string description: The list of Creatives to be copied. source_product_id: type: string description: The ID of the source app. target_product_id: type: string description: The ID of the target app. target_ad_account_id: type: string title: The ID of the target AdAccount, Optional required: - ad_account_id - creative_ids - source_product_id - target_product_id messagesCopyCreativesSyncResponse: type: object properties: success: type: boolean results: type: array items: type: object $ref: '#/components/schemas/CopyCreativesSyncResponseCopyCreativesSyncResult' description: The list of results for copying the Creatives. messagesCreateAdAccountError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesCreateAdAccountErrorAPIErrorInfo' messagesCreateAdAccountErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesCreateAdAccountErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesCreateAdAccountErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN default: ERROR_REASON_UNKNOWN messagesCreateAdAccountResponse: type: object properties: ad_account: $ref: '#/components/schemas/dspAdAccount' description: The created AdAccount data. messagesCreateAdGroupError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesCreateAdGroupErrorAPIErrorInfo' messagesCreateAdGroupErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesCreateAdGroupErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesCreateAdGroupErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN - AD_GROUP_PRICING_MODEL_NOT_SUPPORTED_FOR_CAMPAIGN_TYPE - AD_GROUP_TARGET_DUPLICATED_AD_PLATFORM - AD_GROUP_AD_PLATFORMS_SHOULD_BE_SUBSET_OF_CAMPAIGN default: ERROR_REASON_UNKNOWN description: " - AD_GROUP_PRICING_MODEL_NOT_SUPPORTED_FOR_CAMPAIGN_TYPE: unsupported pricing model id for direct sold\ \ ad or house ad.\n - AD_GROUP_TARGET_DUPLICATED_AD_PLATFORM: AdGroup has duplicated targeting ad platform.\n - AD_GROUP_AD_PLATFORMS_SHOULD_BE_SUBSET_OF_CAMPAIGN:\ \ AdGroup's targeting ad platforms should be subset of campaign's." messagesCreateAdGroupResponse: type: object properties: ad_group: $ref: '#/components/schemas/dspAdGroup' description: Created AdGroup data. messagesCreateAssetUploadSessionError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesCreateAssetUploadSessionErrorAPIErrorInfo' title: creative related errors messagesCreateAssetUploadSessionErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesCreateAssetUploadSessionErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesCreateAssetUploadSessionErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN default: ERROR_REASON_UNKNOWN messagesCreateAssetUploadSessionResponse: type: object properties: asset_url: type: string description: Actual URL to reach to the asset. content_upload_url: type: string description: 'Temporal URL to upload the actual content of the asset. It will be expired in an hour. To update the asset content, follow [the instruction](https://developer.moloco.cloud/docs/campaign-management-api#4-1-upload-a-creative-asset-to-storage-for-those-using-moloco-ads-api-v17-or-later).' description: Response that contains information for the created asset upload session. messagesCreateAudienceTargetError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesCreateAudienceTargetErrorAPIErrorInfo' messagesCreateAudienceTargetErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesCreateAudienceTargetErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesCreateAudienceTargetErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN - AUDIENCE_TARGET_NOT_FOUND - AUDIENCE_TARGET_LATITUDE_VALUE_NOT_IN_RANGE - AUDIENCE_TARGET_LONGITUDE_VALUE_NOT_IN_RANGE - AUDIENCE_TARGET_INVALID_AGE_CONDITION - AUDIENCE_TARGET_INVALID_USER_BUCKET_RANGE - AUDIENCE_TARGET_INVALID_PAST_TIME_RANGE - AUDIENCE_TARGET_FAILED_TO_PARSE_CONDITION - AUDIENCE_TARGET_INVALID_KEYWORD - AUDIENCE_TARGET_INVALID_AUCTION_TYPE - AUDIENCE_TARGET_INVALID_THROTTLE_RATE - AUDIENCE_TARGET_CANNOT_USE_WHITESPACE - AUDIENCE_TARGET_AT_LEAST_ID_OR_KEYWORDS_MUST_BE_SET - AUDIENCE_TARGET_CANNOT_SET_BOTH_PAST_TIME_RANGE_AND_RANGE - AUDIENCE_TARGET_CONDITION_RANGE_CANNOT_HAVE_SAME_START_AND_END_VALUE - AUDIENCE_TARGET_CANNOT_EXCLUDE_ALL_CONDITION - AUDIENCE_TARGET_CANNOT_HAVE_BOTH_ALL_AND_ANY - AUDIENCE_TARGET_LENGTH_EXCEED_LIMIT default: ERROR_REASON_UNKNOWN description: " - AUDIENCE_TARGET_NOT_FOUND: Cannot find the requested audience.\n - AUDIENCE_TARGET_LATITUDE_VALUE_NOT_IN_RANGE:\ \ targeting_condition has an invalid latitude value, which should be between 0 and 90.\n - AUDIENCE_TARGET_LONGITUDE_VALUE_NOT_IN_RANGE:\ \ targeting_condition has an invalid longitude value, which should be between -180 and 180.\n - AUDIENCE_TARGET_INVALID_AGE_CONDITION:\ \ targeting_condition has an invalid age condition, it should be between 0 and 100.\n - AUDIENCE_TARGET_INVALID_USER_BUCKET_RANGE:\ \ user bucket should be a number between 0 and 100.\n - AUDIENCE_TARGET_INVALID_PAST_TIME_RANGE: The absolute time\ \ range would be calculated as [now - Start, now - End).\nSo the start value should be larger than the end value,\ \ and the end value cannot be negative.\n - AUDIENCE_TARGET_FAILED_TO_PARSE_CONDITION: condition value cannot be parsed.\n\ \ - AUDIENCE_TARGET_INVALID_KEYWORD: Keyword cannot be empty or have whitespace characters only.\n - AUDIENCE_TARGET_INVALID_AUCTION_TYPE:\ \ auction_type should be FIRST or SECOND.\n - AUDIENCE_TARGET_INVALID_THROTTLE_RATE: throttle_rate should be between\ \ 0.0 and 1.0.\n - AUDIENCE_TARGET_CANNOT_USE_WHITESPACE: Cannot use whitespace for given audience target condition\ \ field.\n - AUDIENCE_TARGET_AT_LEAST_ID_OR_KEYWORDS_MUST_BE_SET: One of id or keywords of audience target condition\ \ field should be set.\n - AUDIENCE_TARGET_CANNOT_SET_BOTH_PAST_TIME_RANGE_AND_RANGE: Audience target condition field\ \ cannot have both past time range and range at the same time.\n - AUDIENCE_TARGET_CONDITION_RANGE_CANNOT_HAVE_SAME_START_AND_END_VALUE:\ \ Audience target condition range cannot have same start and end value.\n - AUDIENCE_TARGET_CANNOT_EXCLUDE_ALL_CONDITION:\ \ AudienceTarget condition cannot exclude all target conditions in specified field.\n - AUDIENCE_TARGET_CANNOT_HAVE_BOTH_ALL_AND_ANY:\ \ targeting_condition must not have both 'all' and 'any' in the same side of custom audience set.\n - AUDIENCE_TARGET_LENGTH_EXCEED_LIMIT:\ \ The length of the target condition exceeds the limit." messagesCreateAudienceTargetResponse: type: object properties: audience_target: $ref: '#/components/schemas/dspSharedAudienceTarget' description: The created AudienceTarget data. messagesCreateCampaignError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesCreateCampaignErrorAPIErrorInfo' title: CampaignError messagesCreateCampaignErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesCreateCampaignErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesCreateCampaignErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN - CAMPAIGN_SKAN_MUST_BE_UNSET_FOR_NON_IOS_CAMPAIGN - CAMPAIGN_SKAN_MUST_BE_SET_FOR_IOS_CAMPAIGN - CAMPAIGN_SKAN_CUSTOM_OPTIONS_REQUIRED - CAMPAIGN_TYPE_TRACKING_LINK_REQUIRED - CAMPAIGN_TYPE_LANDING_URL_NOT_ALLOWED - CAMPAIGN_TYPE_LANDING_URL_REQUIRED - CAMPAIGN_TYPE_TRACKING_LINK_NOT_ALLOWED - CAMPAIGN_GOAL_CANNOT_CREATE - CAMPAIGN_TYPE_CANNOT_CREATE_FOR_NON_APP_PRODUCT - CAMPAIGN_TYPE_REQUIRES_APP_PROPERTIES - CAMPAIGN_NO_VALID_TRACKING_COMPANY - CAMPAIGN_SKAN_INVALID_GOAL_ACTION - CAMPAIGN_NO_REVENUE_FOR_EVENT - CAMPAIGN_TYPE_MISMATCH_WITH_GOAL - CAMPAIGN_PAYOUT_ITEM_NUMBER_MISMATCH - CAMPAIGN_BUDGET_CURRENCY_MISMATCH - CAMPAIGN_OS_MISMATCH_WITH_TRACKING_LINK_OS - CAMPAIGN_PRODUCT_INCOMPATIBLE - CAMPAIGN_GOAL_TYPE_NOT_AVAILABLE - CAMPAIGN_SKAN_REACHED_MAX - CAMPAIGN_SKAN_PROHIBIT_WITHOUT_OWNERSHIP - CAMPAIGN_CREATIVE_GROUPS_NOT_FOUND - CAMPAIGN_BUDGET_REQUIRED - CAMPAIGN_ZERO_BUDGET_AE_CAMPAIGN_NOT_DISABLED - CAMPAIGN_TARGET_DUPLICATED_AD_PLATFORM - CAMPAIGN_AD_PLATFORMS_SHOULD_BE_SUPERSET_OF_AD_GROUPS - CAMPAIGN_TYPE_CANNOT_TARGET_MULTIPLE_OSES default: ERROR_REASON_UNKNOWN description: " - CAMPAIGN_SKAN_MUST_BE_UNSET_FOR_NON_IOS_CAMPAIGN: Cannot specify skadn_input for non IOS campaign.\n\ \ - CAMPAIGN_SKAN_MUST_BE_SET_FOR_IOS_CAMPAIGN: Must specify skadn_input for IOS campaign.\n - CAMPAIGN_SKAN_CUSTOM_OPTIONS_REQUIRED:\ \ custom_options must be set for skadn_input.\n - CAMPAIGN_TYPE_TRACKING_LINK_REQUIRED: tracking_link_id is required\ \ for APP installs or re-engagement type campaign.\n - CAMPAIGN_TYPE_LANDING_URL_NOT_ALLOWED: landing_url is not allowed\ \ for APP installs or re-engagement type campaign.\n - CAMPAIGN_TYPE_LANDING_URL_REQUIRED: landing_url is required\ \ for WEB type campaign.\n - CAMPAIGN_TYPE_TRACKING_LINK_NOT_ALLOWED: campaign.tracking_link_id is not allowed for\ \ WEB type campaign.\n - CAMPAIGN_GOAL_CANNOT_CREATE: Cannot create a campaign with specified goal type.\n - CAMPAIGN_TYPE_CANNOT_CREATE_FOR_NON_APP_PRODUCT:\ \ Specified campaign type cannot have non APP type product.\n - CAMPAIGN_TYPE_REQUIRES_APP_PROPERTIES: Specified campaign\ \ type should have APP properties under the Product.\n - CAMPAIGN_NO_VALID_TRACKING_COMPANY: Creating campaign has\ \ invalid tracking company information.\nInput tracking link id should be set or target Product should have postback\ \ integration.\n - CAMPAIGN_SKAN_INVALID_GOAL_ACTION: The specified goal action is not valid event for SKAdNetwork.\n\ \ - CAMPAIGN_NO_REVENUE_FOR_EVENT: The specified goal action does not have revenue range.\n - CAMPAIGN_TYPE_MISMATCH_WITH_GOAL:\ \ The campaign cannot have specified type for the specified goal.\n - CAMPAIGN_PAYOUT_ITEM_NUMBER_MISMATCH: The number\ \ of PayoutItem should be matched with the length of Campaigns or 0.\n - CAMPAIGN_BUDGET_CURRENCY_MISMATCH: The budget\ \ currency should match the currency of the Campaign.\n - CAMPAIGN_OS_MISMATCH_WITH_TRACKING_LINK_OS: Target OS of\ \ campaign does not match with target OS of TrackingLink.\n - CAMPAIGN_PRODUCT_INCOMPATIBLE: The campaign type is\ \ incompatible with target product.\n - CAMPAIGN_GOAL_TYPE_NOT_AVAILABLE: The goal type is not available.\n - CAMPAIGN_SKAN_REACHED_MAX:\ \ Maximum number of campaigns per App targeting SKAdNetwork compatible traffic has already reached.\n - CAMPAIGN_SKAN_PROHIBIT_WITHOUT_OWNERSHIP:\ \ Creating SKAdNetwork targeting campaigns is not allowed without the ownership for the iOS app.\n - CAMPAIGN_CREATIVE_GROUPS_NOT_FOUND:\ \ Cannot find matching CreativeGroups for specified creative_group_ids.\n - CAMPAIGN_BUDGET_REQUIRED: Campaign budget\ \ is required.\n - CAMPAIGN_ZERO_BUDGET_AE_CAMPAIGN_NOT_DISABLED: Campaign should be disabled if budget_ratio_percent\ \ of audience extension is 0% or 100%.\n - CAMPAIGN_TARGET_DUPLICATED_AD_PLATFORM: Campaign has duplicated targeting\ \ ad platform.\n - CAMPAIGN_AD_PLATFORMS_SHOULD_BE_SUPERSET_OF_AD_GROUPS: Campaign's targeting ad platforms should\ \ be superset of AdGroups'.\n - CAMPAIGN_TYPE_CANNOT_TARGET_MULTIPLE_OSES: Given campaign type cannot target multiple\ \ OSes." messagesCreateCampaignResponse: type: object properties: campaign: $ref: '#/components/schemas/dspCampaign' description: The created Campaign data. ad_groups: type: array items: type: object $ref: '#/components/schemas/dspAdGroup' description: The AdGroup data which has been created along with the Campaign. postback_integration_status: $ref: '#/components/schemas/dspPostbackIntegrationStatus' description: The postback integration status. messagesCreateCreativeError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesCreateCreativeErrorAPIErrorInfo' messagesCreateCreativeErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesCreateCreativeErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesCreateCreativeErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN - CREATIVE_MUST_BE_ASSET_URL - CREATIVE_VIDEO_TYPE_SHOULD_HAVE_SINGLE_COMPANION_IMAGE - CREATIVE_VIDEO_TYPE_SHOULD_HAVE_SINGLE_ENDCARD_TYPE - CREATIVE_INVALID_IMAGE_FORMAT - CREATIVE_UNSUPPORTED_IMAGE_FORMAT - CREATIVE_MALFORMED_URL - CREATIVE_AT_LEAST_ONE_FIELD_MUST_BE_FILLED - CREATIVE_TYPE_AUTO_PLAY_AUDIO_ATTRIBUTE_INVALID - CREATIVE_PLAYABLE_AD_INVALID_SOURCE_DATA - CREATIVE_PLAYABLE_AD_SOURCE_URL_INVALID_PREFIX - CREATIVE_NOT_SUPPORTED_IMAGE_DIMENSION - CREATIVE_NO_ALLOWED_IMAGE_SIZE_ON_DSP_CONFIGURATION - CREATIVE_TYPE_NOT_ALLOWED_VALUE_IN_PLAYABLE_AD_SOURCE - CREATIVE_TYPE_MUST_CONTAIN_ON_CTA_CLICK - CREATIVE_ON_CTA_CLICK_CANNOT_HAVE_ARGUMENT - CREATIVE_TWO_VALUES_SHOULD_BE_SAME - CREATIVE_FEATURE_TYPE_DYNAMIC_CREATIVE_NOT_SUPPORTED - CREATIVE_INVALID_CRID_FORMAT - CREATIVE_INVALID_ICON_IMAGE_SHAPE - CREATIVE_ONLY_ONE_SOURCE_ALLOWED - CREATIVE_SRC_SIZE_ATTRS_REQUIRED_FOR_NON_INTERSTITIAL - CREATIVE_INVALID_VIDEO_SRC_EXTENSION - CREATIVE_NO_VALID_COMPANION_IMAGE - CREATIVE_VIDEO_REQUIRED_FOR_CTV - CREATIVE_ENDCARD_NOT_SUPPORTED_FOR_CTV_VIDEO - CREATIVE_TRANSCODED_VIDEO_SRC_SIZE_LIMIT_EXCEEDED - CREATIVE_VIDEO_SRC_INVALID_DIMENSION - CREATIVE_VIDEO_SRC_LENGTH_NOT_IN_LIMIT default: ERROR_REASON_UNKNOWN description: " - CREATIVE_MUST_BE_ASSET_URL: image URL should be asset url but user used wrong url by its prefix.\n\ \ - CREATIVE_VIDEO_TYPE_SHOULD_HAVE_SINGLE_COMPANION_IMAGE: video type should have single companion image.\n - CREATIVE_VIDEO_TYPE_SHOULD_HAVE_SINGLE_ENDCARD_TYPE:\ \ video type should have a single endcard type.\n - CREATIVE_INVALID_IMAGE_FORMAT: invalid image format.\n - CREATIVE_UNSUPPORTED_IMAGE_FORMAT:\ \ unsupported image format.\n - CREATIVE_MALFORMED_URL: URL cannot be parsed.\n - CREATIVE_AT_LEAST_ONE_FIELD_MUST_BE_FILLED:\ \ at least one field should be filled.\n - CREATIVE_TYPE_AUTO_PLAY_AUDIO_ATTRIBUTE_INVALID: rich_custom_html with\ \ Facebook HTML should specify the auto_play_audio attribute (true/false).\n - CREATIVE_PLAYABLE_AD_INVALID_SOURCE_DATA:\ \ playable_ad_source_data has invalid value.\n - CREATIVE_PLAYABLE_AD_SOURCE_URL_INVALID_PREFIX: playable ad source\ \ url should be prefixed with domain name.\n - CREATIVE_NOT_SUPPORTED_IMAGE_DIMENSION: Specified image dimension is\ \ not supported.\n - CREATIVE_NO_ALLOWED_IMAGE_SIZE_ON_DSP_CONFIGURATION: no allowed image size is defined on dap\ \ configuration.\n - CREATIVE_TYPE_NOT_ALLOWED_VALUE_IN_PLAYABLE_AD_SOURCE: Value used in playable ad source is not\ \ allowed.\n - CREATIVE_TYPE_MUST_CONTAIN_ON_CTA_CLICK: FbPlayableAd.onCTAClick must be contained.\n - CREATIVE_ON_CTA_CLICK_CANNOT_HAVE_ARGUMENT:\ \ FbPlayableAd.onCTAClick must be inserted without an argument.\n - CREATIVE_TWO_VALUES_SHOULD_BE_SAME: two values\ \ should be same.\n - CREATIVE_FEATURE_TYPE_DYNAMIC_CREATIVE_NOT_SUPPORTED: Creative feature type is DYNAMIC_CREATIVE\ \ type but target app does not support Dynamic Creative Feature.\n - CREATIVE_INVALID_CRID_FORMAT: CRID has invalid\ \ format.\n - CREATIVE_INVALID_ICON_IMAGE_SHAPE: Creative icon image should be square.\n - CREATIVE_ONLY_ONE_SOURCE_ALLOWED:\ \ Creative can have only one source.\n - CREATIVE_SRC_SIZE_ATTRS_REQUIRED_FOR_NON_INTERSTITIAL: Specified non interstitial\ \ source type needs fixed attribute.\n - CREATIVE_INVALID_VIDEO_SRC_EXTENSION: Only mp4 is allowed for video_src extension.\n\ \ - CREATIVE_NO_VALID_COMPANION_IMAGE: All companion image has invalid dimensions.\n - CREATIVE_VIDEO_REQUIRED_FOR_CTV:\ \ Only Video creative is allowed for CTV product.\n - CREATIVE_ENDCARD_NOT_SUPPORTED_FOR_CTV_VIDEO: Endcard is not\ \ supported for CTV product video creative.\n - CREATIVE_TRANSCODED_VIDEO_SRC_SIZE_LIMIT_EXCEEDED: The video size\ \ after transcoding exceeds the size limit.\n - CREATIVE_VIDEO_SRC_INVALID_DIMENSION: At least one of the dimensions\ \ of the video, either the width or the height, should be greater than or equal to 640 pixels.\n - CREATIVE_VIDEO_SRC_LENGTH_NOT_IN_LIMIT:\ \ The video length should be between 6 and 100 seconds, inclusive." messagesCreateCreativeGroupError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesCreateCreativeGroupErrorAPIErrorInfo' messagesCreateCreativeGroupErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesCreateCreativeGroupErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesCreateCreativeGroupErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN - CREATIVE_MUST_BE_ASSET_URL - CREATIVE_VIDEO_TYPE_SHOULD_HAVE_SINGLE_COMPANION_IMAGE - CREATIVE_VIDEO_TYPE_SHOULD_HAVE_SINGLE_ENDCARD_TYPE - CREATIVE_INVALID_IMAGE_FORMAT - CREATIVE_UNSUPPORTED_IMAGE_FORMAT - CREATIVE_MALFORMED_URL - CREATIVE_AT_LEAST_ONE_FIELD_MUST_BE_FILLED - CREATIVE_TYPE_AUTO_PLAY_AUDIO_ATTRIBUTE_INVALID - CREATIVE_PLAYABLE_AD_SOURCE_URL_INVALID_PREFIX - CREATIVE_NOT_SUPPORTED_IMAGE_DIMENSION - CREATIVE_NO_ALLOWED_IMAGE_SIZE_ON_DSP_CONFIGURATION - CREATIVE_TYPE_NOT_ALLOWED_VALUE_IN_PLAYABLE_AD_SOURCE - CREATIVE_TYPE_MUST_CONTAIN_ON_CTA_CLICK - CREATIVE_ON_CTA_CLICK_CANNOT_HAVE_ARGUMENT - CREATIVE_TWO_VALUES_SHOULD_BE_SAME - CREATIVE_GROUP_INVALID_APP_ICON_IMAGE_SHAPE - CREATIVE_GROUP_INVALID_BRAND_LOGO_IMAGE_SHAPE - CREATIVE_GROUP_SMALL_IMAGE_SIZE - CREATIVE_GROUP_EXCEED_CTA_TEXT_LENGTH - CREATIVE_GROUP_INVALID_CTA_COLOR_CODE - CREATIVE_GROUP_FEATURE_TYPE_NOT_MATCH_CREATIVE_FEATURE_TYPE - CREATIVE_GROUP_NEEDS_PRODUCT - CREATIVE_GROUP_VIDEO_AD_EVENT_TRACKERS_EXCEED_LIMIT default: ERROR_REASON_UNKNOWN description: " - CREATIVE_MUST_BE_ASSET_URL: image URL should be asset url but user used wrong url by its prefix.\n\ \ - CREATIVE_VIDEO_TYPE_SHOULD_HAVE_SINGLE_COMPANION_IMAGE: video type should have single companion image.\n - CREATIVE_VIDEO_TYPE_SHOULD_HAVE_SINGLE_ENDCARD_TYPE:\ \ video type should have a single endcard type.\n - CREATIVE_INVALID_IMAGE_FORMAT: invalid image format.\n - CREATIVE_UNSUPPORTED_IMAGE_FORMAT:\ \ unsupported image format.\n - CREATIVE_MALFORMED_URL: URL cannot be parsed.\n - CREATIVE_AT_LEAST_ONE_FIELD_MUST_BE_FILLED:\ \ at least one field should be filled.\n - CREATIVE_TYPE_AUTO_PLAY_AUDIO_ATTRIBUTE_INVALID: rich_custom_html with\ \ Facebook HTML should specify the auto_play_audio attribute (true/false).\n - CREATIVE_PLAYABLE_AD_SOURCE_URL_INVALID_PREFIX:\ \ playable ad source url should be prefixed with domain name.\n - CREATIVE_NOT_SUPPORTED_IMAGE_DIMENSION: Specified\ \ image dimension is not supported.\n - CREATIVE_NO_ALLOWED_IMAGE_SIZE_ON_DSP_CONFIGURATION: no allowed image size\ \ is defined on dap configuration.\n - CREATIVE_TYPE_NOT_ALLOWED_VALUE_IN_PLAYABLE_AD_SOURCE: Value used in playable\ \ ad source is not allowed.\n - CREATIVE_TYPE_MUST_CONTAIN_ON_CTA_CLICK: FbPlayableAd.onCTAClick must be contained.\n\ \ - CREATIVE_ON_CTA_CLICK_CANNOT_HAVE_ARGUMENT: FbPlayableAd.onCTAClick must be inserted without an argument.\n -\ \ CREATIVE_TWO_VALUES_SHOULD_BE_SAME: two values should be same.\n - CREATIVE_GROUP_INVALID_APP_ICON_IMAGE_SHAPE:\ \ App icon image should be square.\n - CREATIVE_GROUP_INVALID_BRAND_LOGO_IMAGE_SHAPE: Brand logo image should be horizontal.\n\ \ - CREATIVE_GROUP_SMALL_IMAGE_SIZE: Image width and height must be greater than 256 px.\n - CREATIVE_GROUP_EXCEED_CTA_TEXT_LENGTH:\ \ Maximum length of call to action text is 8.\n - CREATIVE_GROUP_INVALID_CTA_COLOR_CODE: Cta color code should be\ \ formatted to 24-bit RGB hexadecimal representation.\n - CREATIVE_GROUP_FEATURE_TYPE_NOT_MATCH_CREATIVE_FEATURE_TYPE:\ \ The feature type of Creative should match the feature type of Creative Group.\n - CREATIVE_GROUP_NEEDS_PRODUCT:\ \ CreativeGroup with TrackingLink or LandingUrl needs Product.\n - CREATIVE_GROUP_VIDEO_AD_EVENT_TRACKERS_EXCEED_LIMIT:\ \ The number of trackers used from VideoAdEventTrackers exceeds limit. The limit is up to 3 per event." messagesCreateCreativeGroupResponse: type: object properties: creative_group: $ref: '#/components/schemas/dspCreativeGroup' description: The created CreativeGroup data. creatives: type: array items: type: object $ref: '#/components/schemas/dspCreative' description: The Creatives in the retrieved CreativeGroup. tracking_link: $ref: '#/components/schemas/dspTrackingLink' description: The TrackingLink used in the retrieved CreativeGroup. messagesCreateCreativeResponse: type: object properties: creative: $ref: '#/components/schemas/dspCreative' description: The created Creative data. messagesCreateCustomerSetError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesCreateCustomerSetErrorAPIErrorInfo' messagesCreateCustomerSetErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesCreateCustomerSetErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesCreateCustomerSetErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN - CUSTOMER_SET_INVALID_DATA_FILE_PATH - CUSTOMER_SET_DATA_FILE_PATH_AD_ACCOUNT_MISMATCH - CUSTOMER_SET_DATA_FILE_PATH_INVALID_ASSET_KIND - CUSTOMER_SET_DATA_FILE_PATH_MISSING_FILE_NAME - CUSTOMER_SET_MANIPULATION_NOT_ALLOWED default: ERROR_REASON_UNKNOWN description: " - CUSTOMER_SET_INVALID_DATA_FILE_PATH: Data file path cannot be recognized. It should be in format https://cdn-f.adsmoloco.com/{ad_account_id}/csv/{filename}\n\ \ - CUSTOMER_SET_DATA_FILE_PATH_AD_ACCOUNT_MISMATCH: ad_account_id on data path mismatch with request. It should be\ \ in format https://cdn-f.adsmoloco.com/{ad_account_id}/csv/{filename}\n - CUSTOMER_SET_DATA_FILE_PATH_INVALID_ASSET_KIND:\ \ asset kind on data path should be 'csv'. It should be in format https://cdn-f.adsmoloco.com/{ad_account_id}/csv/{filename}\n\ \ - CUSTOMER_SET_DATA_FILE_PATH_MISSING_FILE_NAME: file name on asset kind is missing. It should be in format https://cdn-f.adsmoloco.com/{ad_account_id}/csv/{filename}\n\ \ - CUSTOMER_SET_MANIPULATION_NOT_ALLOWED: CustomerSet manipulation (creation, update, deletion) is only allowed when\ \ data source is data file path." messagesCreateCustomerSetResponse: type: object properties: customer_set: $ref: '#/components/schemas/dspCustomerSet' description: The created CustomerSet. messagesCreateLogResponse: type: object example: log: id: newlyCreatedLogId ad_account_id: sampleAdAccountId type: IMP format: CSV date: '2020-01-01' created_at: '2020-01-01T03:12:50.124101982Z' updated_at: '2020-01-01T03:12:50.124101982Z' href: https://managefnt.adsmoloco.com/cm/v1/logs/newlyCreatedLogId status: https://managefnt.adsmoloco.com/cm/v1/logs/newlyCreatedLogId/status properties: log: $ref: '#/components/schemas/dspLog' description: The details of a created log. href: type: string description: Reference URL that shows the log. status: type: string description: Reference URL that shows the most recent status of the log. messagesCreateProductError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesCreateProductErrorAPIErrorInfo' messagesCreateProductErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesCreateProductErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesCreateProductErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN - PRODUCT_INVALID_APP_RATING - PRODUCT_INVALID_APP_POSTBACK_INTEGRATION_BUNDLE - PRODUCT_INVALID_APP_BUNDLE_PATTERN - PRODUCT_TRACKING_BUNDLE_CANNOT_CONTAIN_LEADING_OR_TRAILING_WHITESPACE - PRODUCT_OS_MISMATCH_WITH_STORE_URL - PRODUCT_INVALID_APP_STORE_URL - PRODUCT_NOT_SUPPORTED_MMP_FOR_WEB default: ERROR_REASON_UNKNOWN description: " - PRODUCT_INVALID_APP_RATING: The product's app property has invalid rating.\n - PRODUCT_INVALID_APP_POSTBACK_INTEGRATION_BUNDLE:\ \ Invalid bundle of the product's app postback integration.\n - PRODUCT_INVALID_APP_BUNDLE_PATTERN: App bundle string\ \ does not match the pattern of specified App store.\n - PRODUCT_TRACKING_BUNDLE_CANNOT_CONTAIN_LEADING_OR_TRAILING_WHITESPACE:\ \ tracking bundle cannot contain leading or trailing whitespace\n - PRODUCT_OS_MISMATCH_WITH_STORE_URL: Specified\ \ OS does not match with store URL.\n - PRODUCT_INVALID_APP_STORE_URL: App store cannot be identified from the URL.\n\ \ - PRODUCT_NOT_SUPPORTED_MMP_FOR_WEB: Given product mmp is not supported for web type. We only support MOLOCO_PIXEL_V2\ \ for web type." messagesCreateProductResponse: type: object properties: product: $ref: '#/components/schemas/dspProduct' description: The created Product data. postback_integration_statuses: type: array items: type: object $ref: '#/components/schemas/dspPostbackIntegrationStatus' description: The postback integration status. messagesCreateReportError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesCreateReportErrorAPIErrorInfo' messagesCreateReportErrorAPIErrorInfo: type: object properties: error_log_id: type: string reason: $ref: '#/components/schemas/messagesCreateReportErrorAPIErrorInfoErrorReason' context: type: object additionalProperties: type: string messagesCreateReportErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN default: ERROR_REASON_UNKNOWN messagesCreateReportExportError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesCreateReportExportErrorAPIErrorInfo' messagesCreateReportExportErrorAPIErrorInfo: type: object properties: error_log_id: type: string reason: $ref: '#/components/schemas/messagesCreateReportExportErrorAPIErrorInfoErrorReason' context: type: object additionalProperties: type: string messagesCreateReportExportErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN default: ERROR_REASON_UNKNOWN messagesCreateReportExportResponse: type: object example: report_export: id: sampleReportExportId workplace_id: samplePlatformId ad_account_id: sampleAdAccountId product_id: sampleProductId partner: SINGULAR created_at: '2020-01-03T03:12:50.124101982Z' updated_at: '2020-01-03T03:24:21.109821241Z' properties: report_export: $ref: '#/components/schemas/dspReportExport' description: The details of a created report export. messagesCreateReportResponse: type: object example: id: newlyCreatedReportId href: https://api.moloco.cloud/cm/v1/reports/newlyCreatedReportId status: https://api.moloco.cloud/cm/v1/reports/newlyCreatedReportId/status properties: id: type: string description: Unique ID of the newly created report. href: type: string description: Reference URL that shows the report. status: type: string description: Reference URL that shows the most recent status of the report. messagesCreateTokenError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesCreateTokenErrorAPIErrorInfo' messagesCreateTokenErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesCreateTokenErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesCreateTokenErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN - USER_INVALID_CREDENTIAL_INFORMATION - USER_ACCOUNT_BLOCKED default: ERROR_REASON_UNKNOWN description: " - USER_INVALID_CREDENTIAL_INFORMATION: The given credential information is invalid.\n - USER_ACCOUNT_BLOCKED:\ \ The user account is blocked.\nLogin attempt is not allowed when there are 5 failed login attempts." messagesCreateTokenRequest: type: object properties: api_key: type: string description: Enter the API key generated from Moloco Cloud DSP. messagesCreateTokenResponse: type: object properties: token: type: string description: Created token. token_type: $ref: '#/components/schemas/dspmessagesTokenType' description: Token type. messagesCreateTrackingLinkError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesCreateTrackingLinkErrorAPIErrorInfo' messagesCreateTrackingLinkErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesCreateTrackingLinkErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesCreateTrackingLinkErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN - TRACKING_LINK_FAILED_TO_CONVERT_LINK - TRACKING_LINK_INVALID_OS_TYPE - TRACKING_LINK_VALIDATION_FAILED default: ERROR_REASON_UNKNOWN description: " - TRACKING_LINK_FAILED_TO_CONVERT_LINK: Failed to convert link url. Use \"Validate a TrackingLink\" API\ \ for details.\n - TRACKING_LINK_INVALID_OS_TYPE: The tracking link has invalid OS type.\n - TRACKING_LINK_VALIDATION_FAILED:\ \ The tracking link has invalid url. Use \"Validate a TrackingLink\" API for details." messagesCreateTrackingLinkResponse: type: object properties: tracking_link: $ref: '#/components/schemas/dspTrackingLink' description: The created TrackingLink data. validation_status: $ref: '#/components/schemas/messagesTrackingLinkValidationStatus' description: 'The validation status of created tracking link. If the status is WARNING, the tracking link has created but has not recommended values. Please check the details using "Validate a TrackingLink" API.' messagesDeleteAdAccountError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesDeleteAdAccountErrorAPIErrorInfo' messagesDeleteAdAccountErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesDeleteAdAccountErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesDeleteAdAccountErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN default: ERROR_REASON_UNKNOWN messagesDeleteAdAccountResponse: type: object messagesDeleteAdGroupError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesDeleteAdGroupErrorAPIErrorInfo' messagesDeleteAdGroupErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesDeleteAdGroupErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesDeleteAdGroupErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN - AD_GROUP_CANNOT_DELETE_ONLY_CHILD default: ERROR_REASON_UNKNOWN description: ' - AD_GROUP_CANNOT_DELETE_ONLY_CHILD: Cannot delete the specified AdGroup, which is the only child of the Campaign.' messagesDeleteAdGroupResponse: type: object messagesDeleteAudienceTargetError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesDeleteAudienceTargetErrorAPIErrorInfo' messagesDeleteAudienceTargetErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesDeleteAudienceTargetErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesDeleteAudienceTargetErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN - AUDIENCE_TARGET_NOT_FOUND - AUDIENCE_TARGET_CANNOT_UPDATE_PREDEFINED_AUDIENCE_TARGET default: ERROR_REASON_UNKNOWN description: " - AUDIENCE_TARGET_NOT_FOUND: Cannot find the requested audience.\n - AUDIENCE_TARGET_CANNOT_UPDATE_PREDEFINED_AUDIENCE_TARGET:\ \ Update for predefined audience target is not allowed." messagesDeleteAudienceTargetResponse: type: object messagesDeleteCampaignError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesDeleteCampaignErrorAPIErrorInfo' messagesDeleteCampaignErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesDeleteCampaignErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesDeleteCampaignErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN default: ERROR_REASON_UNKNOWN messagesDeleteCampaignResponse: type: object messagesDeleteCreativeError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesDeleteCreativeErrorAPIErrorInfo' messagesDeleteCreativeErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesDeleteCreativeErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesDeleteCreativeErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN default: ERROR_REASON_UNKNOWN messagesDeleteCreativeGroupError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesDeleteCreativeGroupErrorAPIErrorInfo' messagesDeleteCreativeGroupErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesDeleteCreativeGroupErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesDeleteCreativeGroupErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN default: ERROR_REASON_UNKNOWN messagesDeleteCreativeGroupResponse: type: object messagesDeleteCreativeGroupsBulkResponse: type: object messagesDeleteCreativeResponse: type: object messagesDeleteCreativesBulkError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesDeleteCreativesBulkErrorAPIErrorInfo' messagesDeleteCreativesBulkErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesDeleteCreativesBulkErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesDeleteCreativesBulkErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN default: ERROR_REASON_UNKNOWN messagesDeleteCreativesBulkResponse: type: object messagesDeleteCustomerSetError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesDeleteCustomerSetErrorAPIErrorInfo' messagesDeleteCustomerSetErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesDeleteCustomerSetErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesDeleteCustomerSetErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN - CUSTOMER_SET_MANIPULATION_NOT_ALLOWED default: ERROR_REASON_UNKNOWN description: ' - CUSTOMER_SET_MANIPULATION_NOT_ALLOWED: CustomerSet manipulation (creation, update, deletion) is only allowed when data source is data file path.' messagesDeleteCustomerSetResponse: type: object messagesDeleteLogResponse: type: object example: {} messagesDeleteProductError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesDeleteProductErrorAPIErrorInfo' messagesDeleteProductErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesDeleteProductErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesDeleteProductErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN default: ERROR_REASON_UNKNOWN messagesDeleteProductResponse: type: object messagesDeleteReportError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesDeleteReportErrorAPIErrorInfo' messagesDeleteReportErrorAPIErrorInfo: type: object properties: error_log_id: type: string reason: $ref: '#/components/schemas/messagesDeleteReportErrorAPIErrorInfoErrorReason' context: type: object additionalProperties: type: string messagesDeleteReportErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN default: ERROR_REASON_UNKNOWN messagesDeleteReportExportError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesDeleteReportExportErrorAPIErrorInfo' messagesDeleteReportExportErrorAPIErrorInfo: type: object properties: error_log_id: type: string reason: $ref: '#/components/schemas/messagesDeleteReportExportErrorAPIErrorInfoErrorReason' context: type: object additionalProperties: type: string messagesDeleteReportExportErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN default: ERROR_REASON_UNKNOWN messagesDeleteReportExportResponse: type: object example: {} messagesDeleteReportResponse: type: object example: {} messagesDeleteTrackingLinkError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesDeleteTrackingLinkErrorAPIErrorInfo' messagesDeleteTrackingLinkErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesDeleteTrackingLinkErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesDeleteTrackingLinkErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN default: ERROR_REASON_UNKNOWN messagesDeleteTrackingLinkResponse: type: object messagesDeleteUserError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesDeleteUserErrorAPIErrorInfo' messagesDeleteUserErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesDeleteUserErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesDeleteUserErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN default: ERROR_REASON_UNKNOWN messagesDeleteUserRequest: type: object properties: email: type: string description: The user email. password: type: string description: The user password. required: - email - password messagesDeleteUserResponse: type: object messagesExpelUserError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesExpelUserErrorAPIErrorInfo' messagesExpelUserErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesExpelUserErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesExpelUserErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN - USER_DOES_NOT_HAVE_REQUIRED_ROLE - USER_NOT_REGISTERED_TO_WORKPLACE default: ERROR_REASON_UNKNOWN description: " - USER_DOES_NOT_HAVE_REQUIRED_ROLE: The user doesn't have role to invite other user.\n - USER_NOT_REGISTERED_TO_WORKPLACE:\ \ The user is not registered to workplace." messagesExpelUserRequest: type: object properties: user_id: type: string description: The user ID. required: - user_id messagesExpelUserResponse: type: object messagesForgotPasswordRequest: type: object properties: email: type: string description: The user email. required: - email messagesForgotPasswordResponse: type: object messagesGrantRoleError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesGrantRoleErrorAPIErrorInfo' messagesGrantRoleErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesGrantRoleErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesGrantRoleErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN - USER_DOES_NOT_HAVE_REQUIRED_ROLE - USER_NOT_REGISTERED_TO_WORKPLACE - USER_ALREADY_HAS_ROLE default: ERROR_REASON_UNKNOWN description: " - USER_DOES_NOT_HAVE_REQUIRED_ROLE: The user doesn't have role to invite other user.\n - USER_NOT_REGISTERED_TO_WORKPLACE:\ \ The user is not registered to workplace.\n - USER_ALREADY_HAS_ROLE: The user has already role bound to the resource." messagesGrantRoleRequest: type: object properties: user_id: type: string description: The user ID. role: $ref: '#/components/schemas/dspRole' description: The role which will be granted to user. required: - user_id - role messagesGrantRoleResponse: type: object messagesInquiryOption: type: string enum: - UNKNOWN_INQUIRY_OPTION - INQUIRY_ENTITY - INQUIRY_OVERVIEW - INQUIRY_ALL default: UNKNOWN_INQUIRY_OPTION description: "InquiryOption defines what information you want for the target entity when sending a request query.\n\ Some of the resources support InquiryOption for List operation, and the actual behavior is defined by each API.\n\n\ This value is not part of the specification.\n\n - INQUIRY_ENTITY: Only the target entity itself is returned in response.\n\ This InquiryOption is faster than other options as it reads the single entity from the database.\n - INQUIRY_OVERVIEW:\ \ The target entity's overview information is returned in response.\nIn general, the overview information includes\ \ the brief content of the target entity and its related entities.\nThis InquiryOption is slower than INQUIRY_ENTITY\ \ but the returned data size is usually smaller than that.\n - INQUIRY_ALL: The target entity and its summary information\ \ is returned in response.\nThis InquiryOption is equivalent to INQUIRY_ENTITY + INQUIRY_OVERVIEW, and it's slow and\ \ big." messagesInviteUserError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesInviteUserErrorAPIErrorInfo' messagesInviteUserErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesInviteUserErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesInviteUserErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN - USER_WORKPLACE_ALREADY_REGISTERED - USER_DOES_NOT_HAVE_REQUIRED_ROLE default: ERROR_REASON_UNKNOWN description: " - USER_WORKPLACE_ALREADY_REGISTERED: The workplace is already registered.\n - USER_DOES_NOT_HAVE_REQUIRED_ROLE:\ \ The user doesn't have role to invite other user." messagesInviteUserRequest: type: object properties: email: type: string description: The user email. name: type: string description: The user name. required: - email - name messagesInviteUserResponse: type: object properties: user: $ref: '#/components/schemas/dspUser' description: Invited user information. messagesListAdAccountUsersResponse: type: object properties: users_with_infos: type: array items: type: object $ref: '#/components/schemas/messagesUserWithInfo' description: List of users contain roles. messagesListAdAccountsError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesListAdAccountsErrorAPIErrorInfo' messagesListAdAccountsErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesListAdAccountsErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesListAdAccountsErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN default: ERROR_REASON_UNKNOWN messagesListAdAccountsResponse: type: object properties: ad_accounts: type: array items: type: object $ref: '#/components/schemas/dspAdAccount' description: The list of AdAccount data. messagesListAdGroupsError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesListAdGroupsErrorAPIErrorInfo' messagesListAdGroupsErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesListAdGroupsErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesListAdGroupsErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN default: ERROR_REASON_UNKNOWN messagesListAdGroupsResponse: type: object properties: ad_groups: type: array items: type: object $ref: '#/components/schemas/dspAdGroup' description: 'The list of AdGroups. This field is valid if the inquiry_option of the request is UNKNOWN_INQUIRY_OPTION or INQUIRY_ENTITY or INQUIRY_ALL. If campaign_id is specified in request, it returns the list of AdGroups under that Campaign. If product_id is specified in request, it returns the list of AdGroups under that Product.' ad_group_overviews: type: array items: type: object $ref: '#/components/schemas/dspAdGroupOverview' description: 'The list of the AdGroup overview information This field is valid if the inquiry_option of the request is INQUIRY_OVERVIEW or INQUIRY_ALL.' messagesListAudienceTargetsError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesListAudienceTargetsErrorAPIErrorInfo' messagesListAudienceTargetsErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesListAudienceTargetsErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesListAudienceTargetsErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN default: ERROR_REASON_UNKNOWN messagesListAudienceTargetsResponse: type: object properties: audience_targets: type: array items: type: object $ref: '#/components/schemas/dspSharedAudienceTarget' description: The list of AudienceTarget data. messagesListCampaignsError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesListCampaignsErrorAPIErrorInfo' messagesListCampaignsErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesListCampaignsErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesListCampaignsErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN default: ERROR_REASON_UNKNOWN messagesListCampaignsResponse: type: object properties: campaigns: type: array items: type: object $ref: '#/components/schemas/dspCampaign' description: The list of Campaigns. messagesListCreativeGroupsError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesListCreativeGroupsErrorAPIErrorInfo' messagesListCreativeGroupsErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesListCreativeGroupsErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesListCreativeGroupsErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN default: ERROR_REASON_UNKNOWN messagesListCreativeGroupsResponse: type: object properties: creative_groups: type: array items: type: object $ref: '#/components/schemas/dspCreativeGroup' description: 'The list of CreativeGroups. This field is valid if the inquiry_option of the request is UNKNOWN_INQUIRY_OPTION or INQUIRY_ENTITY or INQUIRY_ALL.' creative_group_overviews: type: array items: type: object $ref: '#/components/schemas/dspCreativeGroupOverview' description: 'The list of the CreativeGroup overview information. This field is valid if the inquiry_option of the request is INQUIRY_OVERVIEW or INQUIRY_ALL.' messagesListCreativeReviewsError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesListCreativeReviewsErrorAPIErrorInfo' messagesListCreativeReviewsErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesListCreativeReviewsErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesListCreativeReviewsErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN - CREATIVE_REVIEW_FAILED_TO_CONSTRUCT_CRID default: ERROR_REASON_UNKNOWN description: ' - CREATIVE_REVIEW_FAILED_TO_CONSTRUCT_CRID: An error occurs while constructing the crid.' messagesListCreativeReviewsResponse: type: object properties: creative_reviews: type: array items: type: object $ref: '#/components/schemas/dspCreativeReview' messagesListCreativesError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesListCreativesErrorAPIErrorInfo' messagesListCreativesErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesListCreativesErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesListCreativesErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN default: ERROR_REASON_UNKNOWN messagesListCreativesResponse: type: object properties: creatives: type: array items: type: object $ref: '#/components/schemas/dspCreative' description: 'The list of the Creatives. This field is valid if the inquiry_option of the request is UNKNOWN_INQUIRY_OPTION or INQUIRY_ENTITY or INQUIRY_ALL.' creative_overviews: type: array items: type: object $ref: '#/components/schemas/dspCreativeOverview' description: 'The list of the Creative overviews. This field is valid if the inquiry_option of the request is INQUIRY_OVERVIEW or INQUIRY_ALL.' messagesListCustomerSetsError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesListCustomerSetsErrorAPIErrorInfo' messagesListCustomerSetsErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesListCustomerSetsErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesListCustomerSetsErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN default: ERROR_REASON_UNKNOWN messagesListCustomerSetsResponse: type: object properties: customer_sets: type: array items: type: object $ref: '#/components/schemas/dspCustomerSet' description: The list of CustomerSet items. messagesListLogsRequestDateInterval: type: object properties: start: type: string description: Start date in the format of YYYY-MM-DD (inclusive). end: type: string description: End date in the format of YYYY-MM-DD (inclusive). Max 31 days from the start date. required: - start - end messagesListLogsResponse: type: object example: logs: - id: sampleLogId ad_account_id: sampleAdAccountId type: IMP format: CSV date: '2020-01-01' status: ACCEPTED created_at: '2020-01-01T03:12:50.124101982Z' updated_at: '2020-01-01T03:24:21.109821241Z' - id: anotherLogId ad_account_id: sampleAdAccountId type: CLICK format: CSV date: '2020-01-01' status: READY expire_at: '2020-01-01T06:24:21.109821241Z' created_at: '2020-01-01T05:12:50.124101982Z' updated_at: '2020-01-01T05:24:21.109821241Z' properties: logs: type: array items: type: object $ref: '#/components/schemas/dspLog' description: List of logs in the given Workplace. messagesListProductsError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesListProductsErrorAPIErrorInfo' messagesListProductsErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesListProductsErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesListProductsErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN default: ERROR_REASON_UNKNOWN messagesListProductsResponse: type: object properties: products: type: array items: type: object $ref: '#/components/schemas/dspProduct' description: The list of Products. messagesListReportActionEventsResponse: type: object properties: action_events: type: array items: type: string messagesListReportExportsError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesListReportExportsErrorAPIErrorInfo' messagesListReportExportsErrorAPIErrorInfo: type: object properties: error_log_id: type: string reason: $ref: '#/components/schemas/messagesListReportExportsErrorAPIErrorInfoErrorReason' context: type: object additionalProperties: type: string messagesListReportExportsErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN default: ERROR_REASON_UNKNOWN messagesListReportExportsResponse: type: object example: report_exports: - id: sampleReportExportId workplace_id: samplePlatformId ad_account_id: sampleAdAccountId product_id: sampleProductId partner: SINGULAR created_at: '2020-01-03T03:12:50.124101982Z' updated_at: '2020-01-03T03:24:21.109821241Z' - id: anotherReportExportId workplace_id: samplePlatformId ad_account_id: anotherAdAccountId product_id: anotherProductId partner: SINGULAR created_at: '2020-01-03T03:12:50.124101982Z' updated_at: '2020-01-03T03:24:21.109821241Z' properties: report_exports: type: array items: type: object $ref: '#/components/schemas/dspReportExport' description: List of report export in the given Workplace or AdAccount or Product. messagesListReportFiltersResponse: type: object properties: filters: type: array items: type: object $ref: '#/components/schemas/ListReportFiltersResponseReportFilter' messagesListReportsError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesListReportsErrorAPIErrorInfo' messagesListReportsErrorAPIErrorInfo: type: object properties: error_log_id: type: string reason: $ref: '#/components/schemas/messagesListReportsErrorAPIErrorInfoErrorReason' context: type: object additionalProperties: type: string messagesListReportsErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN default: ERROR_REASON_UNKNOWN messagesListReportsResponse: type: object example: reports: - id: sampleReportId ad_account_id: sampleAdAccountId date_range: start: '2020-01-01' end: '2020-01-02' dimensions: - DATE - PRODUCT - CAMPAIGN created_at: '2020-01-03T03:12:50.124101982Z' updated_at: '2020-01-03T03:24:21.109821241Z' - id: anothreReportId ad_account_id: sampleAdAccountId date_range: start: '2020-01-03' end: '2020-01-04' dimensions: - DATE - PRODUCT - CAMPAIGN - AD_GROUP created_at: '2020-01-05T03:12:50.124101982Z' updated_at: '2020-01-05T03:24:21.109821241Z' properties: reports: type: array items: type: object $ref: '#/components/schemas/dspReport' description: List of reports in the given Workplace and AdAccount. messagesListTrackingLinksError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesListTrackingLinksErrorAPIErrorInfo' messagesListTrackingLinksErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesListTrackingLinksErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesListTrackingLinksErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN default: ERROR_REASON_UNKNOWN messagesListTrackingLinksResponse: type: object properties: tracking_links: type: array items: type: object $ref: '#/components/schemas/dspTrackingLink' description: 'The list of TrackingLinks. This field is valid if the inquiry_option of the request is UNKNOWN_INQUIRY_OPTION or INQUIRY_ENTITY or INQUIRY_ALL.' tracking_link_overviews: type: array items: type: object $ref: '#/components/schemas/dspTrackingLinkOverview' description: 'The list of the TrackingLink overview information. This field is valid if the inquiry_option of the request is INQUIRY_OVERVIEW or INQUIRY_ALL.' messagesListWorkplaceUsersResponse: type: object properties: user_with_infos: type: array items: type: object $ref: '#/components/schemas/messagesUserWithInfo' description: List of users with additional info. messagesListWorkplacesByDomainResponse: type: object properties: workplaces: type: array items: type: object $ref: '#/components/schemas/dspWorkplaceWithInvitation' description: The list of workplace with invitation status. messagesListWorkplacesResponse: type: object properties: workplaces: type: array items: type: object $ref: '#/components/schemas/dspWorkplace' description: The list of workplace. workplace_history: $ref: '#/components/schemas/dspWorkplaceHistory' description: The list of workplace creation request histories. messagesQueryAnalyticsDetailRequest: type: object properties: ad_account_id: type: string description: (Required) The ad account id of campaigns to generate the detailed analytics. timezone: type: string description: '(Optional) The timezone to generate the detailed analytics. If not specified, UTC timezone will be used.' date_range: $ref: '#/components/schemas/adcloudcommonDateInterval' description: '(Required) Date range for the detailed analytics to generate. Both start and end dates are inclusive. The specified timezone in the request will be used. Note the allowed maximum duration for the date range is 184 days, to cover the period of 6 months.' dimensions: type: array items: $ref: '#/components/schemas/dspAnalyticsDetailDimension' description: (Required) A list of dimensions. At least one dimension must be selected. metrics: type: array items: $ref: '#/components/schemas/dspAnalyticsDetailMetric' description: (Required) A list of metrics. At least one metric must be selected. dimension_filters: type: array items: type: object $ref: '#/components/schemas/dspAnalyticsDetailDimensionFilter' description: (Optional) A set of filtering conditions of dimensions. metric_filters: type: array items: type: object $ref: '#/components/schemas/dspAnalyticsDetailMetricFilter' description: (Optional) A set of filtering conditions of metrics. conversion_event_filters: type: array items: type: object $ref: '#/components/schemas/dspAnalyticsDetailConversionEventFilter' description: '(Optional) A set of filtering conditions of conversion events. If it is empty, ConversionEvent column will not be retrieved.' conversion_event_metric_filters: type: array items: type: object $ref: '#/components/schemas/dspAnalyticsDetailConversionEventMetricFilter' description: (Optional) A set of filtering conditions for conversion event metrics. order_by_filters: type: array items: type: object $ref: '#/components/schemas/dspAnalyticsDetailOrderByFilter' description: '(Optional) A list of sorting order specification. The order of the messages matters as they are treated sequentially.' limit: type: string format: int64 description: "(Optional) A maximum possible number of rows in the response.\nWhen this field is left empty or equal\ \ to 0, it will return the following number of rows:\n - For the version < 1.7.1: all rows of summary will be\ \ sent through the response.\n - For the version >= 1.7.1: 10000 will be applied as a default.\n - For the version\ \ >= 1.7.1: If the limit value is bigger than 10000, then 10000 will be applied as an upper limit." title: '/////////////////////////////////////////////////////// Analytics Detail' required: - ad_account_id - date_range - dimensions - metrics messagesQueryAnalyticsDetailResponse: type: object properties: rows: type: array items: type: object $ref: '#/components/schemas/dspAnalyticsDetailRow' description: Result rows for the requested query. job: $ref: '#/components/schemas/dspAnalyticsDetailJob' description: The job information executed for the detailed analytics query request. num_rows: type: string format: int64 description: The number of the rows returned. messagesQueryAnalyticsOverviewRequest: type: object properties: ad_account_id: type: string description: (Required) The AdAccount ID to generate the overview. date_range: $ref: '#/components/schemas/adcloudcommonDateInterval' description: '(Required) Date range for the overview to generate. Both start and end dates are inclusive. The specified timezone in the request will be used. Note the allowed maximum duration for the date range is 101 days (184 days for the version >= v1.7.2).' dimensions: type: array items: $ref: '#/components/schemas/dspAnalyticsOverviewDimension' description: '(Required) A list of dimensions. At least one dimension must be selected. Following dimensions are only available for the version >= v1.7.2: - Campaign_GoalType - CreativeGroup-related dimensions - Creative-related dimensions - Exchange_ID - SubPublisher_Type - Inventory_Type For the earlier version, they won''t be supported.' metrics: type: array items: $ref: '#/components/schemas/dspAnalyticsOverviewMetric' description: '(Required) A list of metrics. At least one metric must be selected. Cohort metrics are only available for the version >= v1.7.2.' order_by_filters: type: array items: type: object $ref: '#/components/schemas/dspAnalyticsOverviewOrderByFilter' description: (Optional) Order by conditions. limit: type: string format: int64 description: "(Optional) A maximum possible number of rows in the response.\nWhen this field is left empty or equal\ \ to 0, it will return the following number of rows:\n - For the version < 1.7.1: all rows of summary will be\ \ sent through the response.\n - For the version >= 1.7.1: 10000 will be applied as a default.\n - For the version\ \ >= 1.7.1: If the limit value is bigger than 10000, then 10000 will be applied as an upper limit." dimension_filters: type: array items: type: object $ref: '#/components/schemas/dspAnalyticsOverviewDimensionFilter' description: (Optional) A set of filtering conditions of dimensions. metric_filters: type: array items: type: object $ref: '#/components/schemas/dspAnalyticsOverviewMetricFilter' description: (Optional) A set of filtering conditions of metrics. type: $ref: '#/components/schemas/dspAnalyticsOverviewType' title: '(Optional) Type of the analytics overview. If absent, API request will be treated as UA' title: '/////////////////////////////////////////////////////// Analytics Overview' required: - ad_account_id - date_range - dimensions - metrics messagesQueryAnalyticsOverviewResponse: type: object properties: rows: type: array items: type: object $ref: '#/components/schemas/dspAnalyticsOverviewRow' num_rows: type: string format: int64 description: The number of the rows returned. messagesQueryAnalyticsSKAdNetworkRequest: type: object properties: ad_account_id: type: string description: (Required) The ad account id of campaigns to generate the SKAdNetwork analytics. timezone: type: string description: '(Optional) The timezone to generate the SKAdNetwork analytics. If not specified, UTC timezone will be used.' date_range: $ref: '#/components/schemas/adcloudcommonDateInterval' description: '(Required) Date range for the SKAdNetwork analytics to generate. Both start and end dates are inclusive. The specified timezone in the request will be used. Note the allowed maximum duration for the date range is 184 days, to cover the period of 6 months.' dimensions: type: array items: $ref: '#/components/schemas/dspAnalyticsSKAdNetworkDimension' description: (Required) A list of dimensions. At least one dimension must be selected. skan_conversion_dimensions: type: array items: $ref: '#/components/schemas/AnalyticsSKAdNetworkSKANConversionDimension' description: (Required) A list of SKAN conversion dimensions. At least one dimension must be selected. metrics: type: array items: $ref: '#/components/schemas/dspAnalyticsSKAdNetworkMetric' description: (Required) A list of metrics. At least one metric must be selected. dimension_filters: type: array items: type: object $ref: '#/components/schemas/dspAnalyticsSKAdNetworkDimensionFilter' description: (Optional) A set of filtering conditions of dimensions for the SKAdNetwork analytics. metric_filters: type: array items: type: object $ref: '#/components/schemas/dspAnalyticsSKAdNetworkMetricFilter' description: (Optional) A set of filtering conditions of metrics for the SKAdNetwork analytics. order_by_filters: type: array items: type: object $ref: '#/components/schemas/dspAnalyticsSKAdNetworkOrderByFilter' description: '(Optional) A list of sorting order specification for the SKAdNetwork analytics. The order of the messages matters as they are treated sequentially.' limit: type: string format: int64 description: "(Optional) A maximum possible number of rows in the response.\nWhen this field is left empty or equal\ \ to 0, it will return the following number of rows:\n - For the version < 1.7.1: all rows of summary will be\ \ sent through the response.\n - For the version >= 1.7.1: 10000 will be applied as a default.\n - For the version\ \ >= 1.7.1: If the limit value is bigger than 10000, then 10000 will be applied as an upper limit." title: '/////////////////////////////////////////////////////// Analytics SKAdNetwork' required: - ad_account_id - date_range - dimensions - skan_conversion_dimensions - metrics messagesQueryAnalyticsSKAdNetworkResponse: type: object properties: rows: type: array items: type: object $ref: '#/components/schemas/dspAnalyticsSKAdNetworkRow' description: Result rows for the requested query. job: $ref: '#/components/schemas/dspAnalyticsSKAdNetworkJob' description: The job information executed for the SKAdNetwork analytics query request. messagesQueryCampaignOverviewsResponse: type: object properties: ad_account: $ref: '#/components/schemas/dspAdAccount' description: AdAccount data of the queried Campaigns. product: $ref: '#/components/schemas/dspProduct' description: Product data of the queried Campaigns. campaigns: type: array items: type: object $ref: '#/components/schemas/dspCampaign' description: List of Campaign and it's following AdGroups. ad_groups: type: array items: type: object $ref: '#/components/schemas/dspAdGroup' description: AdGroups of the Campaign. customer_sets: type: array items: type: object $ref: '#/components/schemas/dspCustomerSet' description: List of all the CustomerSet for queried Campaigns. customer_activities: type: array items: type: object $ref: '#/components/schemas/dspCustomerActivity' description: List of all the CustomerActivity for queried Campaigns. tracking_links: type: array items: type: object $ref: '#/components/schemas/dspTrackingLink' description: List of all the TrackingLink for queried Campaigns. creative_groups: type: array items: type: object $ref: '#/components/schemas/dspReadCreativeGroupOverview' description: List of all the CreativeGroup for queried Campaigns. creatives: type: array items: type: object $ref: '#/components/schemas/dspCreative' description: List of all the Creative for queried Campaigns. audience_targets: type: array items: type: object $ref: '#/components/schemas/dspSharedAudienceTarget' description: List of all the SharedAudienceTarget for queried Campaigns. messagesReadAdAccountError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesReadAdAccountErrorAPIErrorInfo' messagesReadAdAccountErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesReadAdAccountErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesReadAdAccountErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN default: ERROR_REASON_UNKNOWN messagesReadAdAccountResponse: type: object properties: ad_account: $ref: '#/components/schemas/dspAdAccount' description: The retrieved AdAccount data. messagesReadAdGroupError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesReadAdGroupErrorAPIErrorInfo' messagesReadAdGroupErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesReadAdGroupErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesReadAdGroupErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN default: ERROR_REASON_UNKNOWN messagesReadAdGroupResponse: type: object properties: ad_group: $ref: '#/components/schemas/dspAdGroup' description: The retrieved AdGroup data. messagesReadAudienceTargetError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesReadAudienceTargetErrorAPIErrorInfo' messagesReadAudienceTargetErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesReadAudienceTargetErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesReadAudienceTargetErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN default: ERROR_REASON_UNKNOWN messagesReadAudienceTargetResponse: type: object properties: audience_target: $ref: '#/components/schemas/dspSharedAudienceTarget' description: The retrieved AudienceTarget data. messagesReadCampaignError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesReadCampaignErrorAPIErrorInfo' messagesReadCampaignErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesReadCampaignErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesReadCampaignErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN - CAMPAIGN_ALREADY_ARCHIVED default: ERROR_REASON_UNKNOWN description: ' - CAMPAIGN_ALREADY_ARCHIVED: The target campaign is already archived.' messagesReadCampaignResponse: type: object properties: campaign: $ref: '#/components/schemas/dspCampaign' description: The retrieved Campaign data. postback_integration_status: $ref: '#/components/schemas/dspPostbackIntegrationStatus' description: The postback integration status. messagesReadCohortSummaryError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesReadCohortSummaryErrorAPIErrorInfo' messagesReadCohortSummaryErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesReadCohortSummaryErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesReadCohortSummaryErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN - COHORT_SUMMARY_INVALID_DATE_RANGE_START - COHORT_SUMMARY_DATE_RANGE_TOO_LONG default: ERROR_REASON_UNKNOWN description: " - COHORT_SUMMARY_INVALID_DATE_RANGE_START: Date range has an invalid start date.\n - COHORT_SUMMARY_DATE_RANGE_TOO_LONG:\ \ Date range is longer than allowed maximum." messagesReadCohortSummaryRequestDateInterval: type: object properties: start: type: string description: Start date in the format of YYYY-MM-DD (inclusive). end: type: string description: 'End date in the format of YYYY-MM-DD (inclusive). Max 31 days from the start date.' required: - start - end messagesReadCohortSummaryResponse: type: object properties: rows: type: array items: type: object $ref: '#/components/schemas/dspCohortSummaryRow' description: Cohort Summary corresponding to the requested AdAccount ID and date range. all_actions: type: array items: type: string description: 'All revenue actions for ROAS or KPI actions for KPI_ACTION which exists during the requested date range.' messagesReadCreativeError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesReadCreativeErrorAPIErrorInfo' messagesReadCreativeErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesReadCreativeErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesReadCreativeErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN default: ERROR_REASON_UNKNOWN messagesReadCreativeGroupError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesReadCreativeGroupErrorAPIErrorInfo' messagesReadCreativeGroupErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesReadCreativeGroupErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesReadCreativeGroupErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN default: ERROR_REASON_UNKNOWN messagesReadCreativeGroupResponse: type: object properties: creative_group: $ref: '#/components/schemas/dspCreativeGroup' description: 'The retrieved CreativeGroup data. This field is valid if the inquiry_option of the request is UNKNOWN_INQUIRY_OPTION or INQUIRY_ENTITY or INQUIRY_ALL.' creative_group_overview: $ref: '#/components/schemas/dspReadCreativeGroupOverview' description: 'The retrieved CreativeGroup overview information. This field is valid if the inquiry_option of the request is INQUIRY_OVERVIEW or INQUIRY_ALL.' creatives: type: array items: type: object $ref: '#/components/schemas/dspCreative' description: The Creatives in the retrieved CreativeGroup. tracking_link: $ref: '#/components/schemas/dspTrackingLink' description: The TrackingLink used in the retrieved CreativeGroup. messagesReadCreativeResponse: type: object properties: creative: $ref: '#/components/schemas/dspCreative' description: The retrieved Creative data. messagesReadCustomerSetError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesReadCustomerSetErrorAPIErrorInfo' messagesReadCustomerSetErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesReadCustomerSetErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesReadCustomerSetErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN default: ERROR_REASON_UNKNOWN messagesReadCustomerSetResponse: type: object properties: customer_set: $ref: '#/components/schemas/dspCustomerSet' description: The retrieved CustomerSet. messagesReadEntityCountResponse: type: object properties: entity_counts: type: array items: type: object $ref: '#/components/schemas/dspEntityCount' description: Entity counts of the given entity type under for each parent scope. messagesReadLogResponse: type: object example: log: id: sampleLogId ad_account_id: sampleAdAccountId type: IMP format: CSV date: '2020-01-01' created_at: '2020-01-01T03:12:50.124101982Z' updated_at: '2020-01-01T03:24:21.109821241Z' properties: log: $ref: '#/components/schemas/dspLog' description: The details of a log. messagesReadLogStatusResponse: type: object example: status: READY location_csv: https://{PLATFORM_LOG_STORAGE}/logs/anExistingLogId.csv?token={ONE_TIME_TOKEN} properties: status: $ref: '#/components/schemas/dspLogStatus' description: Current status of a log. location_csv: type: array items: type: string description: URL of the log contents in CSV form. Will be expired in an hour. location_avro: type: array items: type: string description: URL of the log contents in Avro form. Will be expired in an hour. messagesReadProductAppEventSummaryError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesReadProductAppEventSummaryErrorAPIErrorInfo' messagesReadProductAppEventSummaryErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesReadProductAppEventSummaryErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesReadProductAppEventSummaryErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN default: ERROR_REASON_UNKNOWN messagesReadProductAppEventSummaryResponse: type: object properties: postback_integration_event_summary: $ref: '#/components/schemas/dspPostbackIntegrationEventSummary' description: The events summary of postback integration per each events and time windows. messagesReadProductError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesReadProductErrorAPIErrorInfo' messagesReadProductErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesReadProductErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesReadProductErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN default: ERROR_REASON_UNKNOWN messagesReadProductResponse: type: object properties: product: $ref: '#/components/schemas/dspProduct' description: The retrieved Product data. messagesReadProductSKANConversionConfigError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesReadProductSKANConversionConfigErrorAPIErrorInfo' messagesReadProductSKANConversionConfigErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesReadProductSKANConversionConfigErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesReadProductSKANConversionConfigErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN default: ERROR_REASON_UNKNOWN messagesReadProductSKANConversionConfigFromMmpError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesReadProductSKANConversionConfigFromMmpErrorAPIErrorInfo' messagesReadProductSKANConversionConfigFromMmpErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesReadProductSKANConversionConfigFromMmpErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesReadProductSKANConversionConfigFromMmpErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN default: ERROR_REASON_UNKNOWN messagesReadProductSKANConversionConfigFromMmpResponse: type: object properties: skan_conversion_config: $ref: '#/components/schemas/MmpIntegrationConversionValueConfigurationItem' messagesReadProductSKANConversionConfigResponse: type: object properties: skan_conversion_config: $ref: '#/components/schemas/MmpIntegrationConversionValueConfigurationItem' messagesReadReportError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesReadReportErrorAPIErrorInfo' messagesReadReportErrorAPIErrorInfo: type: object properties: error_log_id: type: string reason: $ref: '#/components/schemas/messagesReadReportErrorAPIErrorInfoErrorReason' context: type: object additionalProperties: type: string messagesReadReportErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN default: ERROR_REASON_UNKNOWN messagesReadReportExportError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesReadReportExportErrorAPIErrorInfo' messagesReadReportExportErrorAPIErrorInfo: type: object properties: error_log_id: type: string reason: $ref: '#/components/schemas/messagesReadReportExportErrorAPIErrorInfoErrorReason' context: type: object additionalProperties: type: string messagesReadReportExportErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN default: ERROR_REASON_UNKNOWN messagesReadReportExportResponse: type: object example: report_export: id: sampleReportExportId workplace_id: samplePlatformId ad_account_id: sampleAdAccountId product_id: sampleProductId partner: SINGULAR created_at: '2020-01-03T03:12:50.124101982Z' updated_at: '2020-01-03T03:24:21.109821241Z' properties: report_export: $ref: '#/components/schemas/dspReportExport' description: The details of a report export. messagesReadReportResponse: type: object example: report: id: sampleReportId ad_account_id: sampleAdAccountId date_range: start: '2020-01-01' end: '2020-01-02' dimensions: - DATE - PRODUCT - CAMPAIGN created_at: '2020-01-03T03:12:50.124101982Z' updated_at: '2020-01-03T03:24:21.109821241Z' properties: report: $ref: '#/components/schemas/dspReport' description: The details of a report. messagesReadReportStatusError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesReadReportStatusErrorAPIErrorInfo' messagesReadReportStatusErrorAPIErrorInfo: type: object properties: error_log_id: type: string reason: $ref: '#/components/schemas/messagesReadReportStatusErrorAPIErrorInfoErrorReason' context: type: object additionalProperties: type: string messagesReadReportStatusErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN default: ERROR_REASON_UNKNOWN messagesReadReportStatusResponse: type: object example: id: anExistingReportId status: READY location_json: https://{WORKPLACE_REPORT_STORAGE}/reports/anExistingReportId.json?token={ONE_TIME_TOKEN} location_csv: https://{WORKPLACE_REPORT_STORAGE}/reports/anExistingReportId.csv?token={ONE_TIME_TOKEN} properties: status: $ref: '#/components/schemas/messagesReadReportStatusResponseStatus' description: Current status of a report. location_json: type: string description: URL of the report contents in JSON form. Will be expired in an hour. location_csv: type: string description: URL of the report contents in CSV form. Will be expired in an hour. messagesReadReportStatusResponseStatus: type: string enum: - UNKNOWN_REPORT_STATUS - ACCEPTED - READY - FAILED default: UNKNOWN_REPORT_STATUS description: "Status enumerates the status of report.\n\n - ACCEPTED: Successfully initiated the report generation request.\n\ \ - READY: Successfully generated the report. It's ready to download from the location.\n - FAILED: Failed to generate\ \ the report. Reasons of failure can be found at errors." messagesReadTrackingLinkError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesReadTrackingLinkErrorAPIErrorInfo' messagesReadTrackingLinkErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesReadTrackingLinkErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesReadTrackingLinkErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN default: ERROR_REASON_UNKNOWN messagesReadTrackingLinkResponse: type: object properties: tracking_link: $ref: '#/components/schemas/dspTrackingLink' description: The retrieved TrackingLink data. attempts: type: array items: type: object $ref: '#/components/schemas/dspTrackingLinkVerificationAttempt' description: The TrackingLink verification attempts related with the TrackingLink. messagesReadUserError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesReadUserErrorAPIErrorInfo' messagesReadUserErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesReadUserErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesReadUserErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN - USER_DOES_NOT_HAVE_REQUIRED_ROLE - USER_AUTH_TOKEN_REQUIRED default: ERROR_REASON_UNKNOWN description: " - USER_DOES_NOT_HAVE_REQUIRED_ROLE: The user doesn't have role to invite other user.\n - USER_AUTH_TOKEN_REQUIRED:\ \ Token should be auth token." messagesReadUserResponse: type: object properties: user_with_info: $ref: '#/components/schemas/messagesUserWithInfo' description: Invited user information. messagesReadWorkplaceResponse: type: object properties: workplace: $ref: '#/components/schemas/dspWorkplace' description: The Workplace. messagesReadWorkplaceSummaryError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesReadWorkplaceSummaryErrorAPIErrorInfo' messagesReadWorkplaceSummaryErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesReadWorkplaceSummaryErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesReadWorkplaceSummaryErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN default: ERROR_REASON_UNKNOWN messagesReadWorkplaceSummaryResponse: type: object properties: rows: type: array items: type: object $ref: '#/components/schemas/dspWorkplaceSummaryRow' description: Workplace summary rows corresponding to the requested Workplace and month range. messagesResetPasswordError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesResetPasswordErrorAPIErrorInfo' messagesResetPasswordErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesResetPasswordErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesResetPasswordErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN - USER_INVALID_PASSWORD - USER_ALREADY_SET_PASSWORD_USING_TOKEN - USER_CANNOT_USE_PREVIOUS_PASSWORD default: ERROR_REASON_UNKNOWN description: " - USER_INVALID_PASSWORD: User password is invalid.\nPassword must be at least 12 characters and contain\ \ at least one number, uppercase letter, lowercase letter and special character.\n - USER_ALREADY_SET_PASSWORD_USING_TOKEN:\ \ The user has already set their password using token.\n - USER_CANNOT_USE_PREVIOUS_PASSWORD: Users cannot reuse previous\ \ password." messagesResetPasswordRequest: type: object properties: password: type: string description: 'The password that user want to change. Password must be at least 12 characters and contain at least one number, uppercase letter, lowercase letter and special character.' email: type: string description: The user email. required: - password - email messagesResetPasswordResponse: type: object messagesRevokeRoleError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesRevokeRoleErrorAPIErrorInfo' messagesRevokeRoleErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesRevokeRoleErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesRevokeRoleErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN - USER_DOES_NOT_HAVE_REQUIRED_ROLE - USER_NOT_REGISTERED_TO_WORKPLACE - USER_ALREADY_HAS_ROLE - USER_NO_ROLE_TO_REVOKE default: ERROR_REASON_UNKNOWN description: " - USER_DOES_NOT_HAVE_REQUIRED_ROLE: The user doesn't have role to invite other user.\n - USER_NOT_REGISTERED_TO_WORKPLACE:\ \ The user is not registered to workplace.\n - USER_ALREADY_HAS_ROLE: The user has already role bound to the resource.\n\ \ - USER_NO_ROLE_TO_REVOKE: The user doesn't have a role to revoke." messagesRevokeRoleRequest: type: object properties: user_id: type: string description: The user ID. role: $ref: '#/components/schemas/dspRole' description: The role which will be revoked from user. required: - user_id - role messagesRevokeRoleResponse: type: object messagesTrackingLinkValidationStatus: type: string enum: - TRACKING_LINK_VALIDATION_STATUS_UNKNOWN - TRACKING_LINK_VALIDATION_STATUS_SUCCESS - TRACKING_LINK_VALIDATION_STATUS_WARNING default: TRACKING_LINK_VALIDATION_STATUS_UNKNOWN description: " - TRACKING_LINK_VALIDATION_STATUS_SUCCESS: Created TrackingLink does not have any warnings.\n - TRACKING_LINK_VALIDATION_STATUS_WARNING:\ \ Created TrackingLink has some warnings." messagesUpdateAdAccountError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesUpdateAdAccountErrorAPIErrorInfo' messagesUpdateAdAccountErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesUpdateAdAccountErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesUpdateAdAccountErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN default: ERROR_REASON_UNKNOWN messagesUpdateAdAccountResponse: type: object properties: ad_account: $ref: '#/components/schemas/dspAdAccount' description: The updated AdAccount data. messagesUpdateAdGroupError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesUpdateAdGroupErrorAPIErrorInfo' messagesUpdateAdGroupErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesUpdateAdGroupErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesUpdateAdGroupErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN - AD_GROUP_TARGET_DUPLICATED_AD_PLATFORM - AD_GROUP_AD_PLATFORMS_SHOULD_BE_SUBSET_OF_CAMPAIGN default: ERROR_REASON_UNKNOWN description: " - AD_GROUP_TARGET_DUPLICATED_AD_PLATFORM: AdGroup has duplicated targeting ad platform.\n - AD_GROUP_AD_PLATFORMS_SHOULD_BE_SUBSET_OF_CAMPAIGN:\ \ AdGroup's targeting ad platforms should be subset of campaign's." messagesUpdateAdGroupResponse: type: object properties: ad_group: $ref: '#/components/schemas/dspAdGroup' description: The updated AdGroup data. messagesUpdateAudienceTargetError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesUpdateAudienceTargetErrorAPIErrorInfo' messagesUpdateAudienceTargetErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesUpdateAudienceTargetErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesUpdateAudienceTargetErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN - AUDIENCE_TARGET_NOT_FOUND - AUDIENCE_TARGET_LATITUDE_VALUE_NOT_IN_RANGE - AUDIENCE_TARGET_LONGITUDE_VALUE_NOT_IN_RANGE - AUDIENCE_TARGET_INVALID_AGE_CONDITION - AUDIENCE_TARGET_INVALID_USER_BUCKET_RANGE - AUDIENCE_TARGET_INVALID_PAST_TIME_RANGE - AUDIENCE_TARGET_FAILED_TO_PARSE_CONDITION - AUDIENCE_TARGET_INVALID_KEYWORD - AUDIENCE_TARGET_INVALID_AUCTION_TYPE - AUDIENCE_TARGET_INVALID_THROTTLE_RATE - AUDIENCE_TARGET_CANNOT_USE_WHITESPACE - AUDIENCE_TARGET_AT_LEAST_ID_OR_KEYWORDS_MUST_BE_SET - AUDIENCE_TARGET_CANNOT_SET_BOTH_PAST_TIME_RANGE_AND_RANGE - AUDIENCE_TARGET_CONDITION_RANGE_CANNOT_HAVE_SAME_START_AND_END_VALUE - AUDIENCE_TARGET_CANNOT_UPDATE_PREDEFINED_AUDIENCE_TARGET - AUDIENCE_TARGET_CANNOT_UPDATE_CUSTOM_TARGET_IN_USE - AUDIENCE_TARGET_CANNOT_EXCLUDE_ALL_CONDITION - AUDIENCE_TARGET_CANNOT_HAVE_BOTH_ALL_AND_ANY - AUDIENCE_TARGET_LENGTH_EXCEED_LIMIT default: ERROR_REASON_UNKNOWN description: " - AUDIENCE_TARGET_NOT_FOUND: Cannot find the requested audience.\n - AUDIENCE_TARGET_LATITUDE_VALUE_NOT_IN_RANGE:\ \ targeting_condition has an invalid latitude value, which should be between 0 and 90.\n - AUDIENCE_TARGET_LONGITUDE_VALUE_NOT_IN_RANGE:\ \ targeting_condition has an invalid longitude value, which should be between -180 and 180.\n - AUDIENCE_TARGET_INVALID_AGE_CONDITION:\ \ targeting_condition has an invalid age condition, it should be between 0 and 100.\n - AUDIENCE_TARGET_INVALID_USER_BUCKET_RANGE:\ \ user bucket should be a number between 0 and 100.\n - AUDIENCE_TARGET_INVALID_PAST_TIME_RANGE: The absolute time\ \ range would be calculated as [now - Start, now - End).\nSo the start value should be larger than the end value,\ \ and the end value cannot be negative.\n - AUDIENCE_TARGET_FAILED_TO_PARSE_CONDITION: condition value cannot be parsed.\n\ \ - AUDIENCE_TARGET_INVALID_KEYWORD: Keyword cannot be empty or have whitespace characters only.\n - AUDIENCE_TARGET_INVALID_AUCTION_TYPE:\ \ auction_type should be FIRST or SECOND.\n - AUDIENCE_TARGET_INVALID_THROTTLE_RATE: throttle_rate should be between\ \ 0.0 and 1.0.\n - AUDIENCE_TARGET_CANNOT_USE_WHITESPACE: Cannot use whitespace for given audience target condition\ \ field.\n - AUDIENCE_TARGET_AT_LEAST_ID_OR_KEYWORDS_MUST_BE_SET: One of id or keywords of audience target condition\ \ field should be set.\n - AUDIENCE_TARGET_CANNOT_SET_BOTH_PAST_TIME_RANGE_AND_RANGE: Audience target condition field\ \ cannot have both past time range and range at the same time.\n - AUDIENCE_TARGET_CONDITION_RANGE_CANNOT_HAVE_SAME_START_AND_END_VALUE:\ \ Audience target condition range cannot have same start and end value.\n - AUDIENCE_TARGET_CANNOT_UPDATE_PREDEFINED_AUDIENCE_TARGET:\ \ Update for predefined audience target is not allowed.\n - AUDIENCE_TARGET_CANNOT_UPDATE_CUSTOM_TARGET_IN_USE: Cannot\ \ add or remove custom audience if the custom target is used in Campaigns or AdGroups.\n - AUDIENCE_TARGET_CANNOT_EXCLUDE_ALL_CONDITION:\ \ AudienceTarget condition cannot exclude all target conditions in specified field.\n - AUDIENCE_TARGET_CANNOT_HAVE_BOTH_ALL_AND_ANY:\ \ targeting_condition must not have both 'all' and 'any' in the same side of custom audience set.\n - AUDIENCE_TARGET_LENGTH_EXCEED_LIMIT:\ \ The length of the target condition exceeds the limit." messagesUpdateAudienceTargetResponse: type: object properties: audience_target: $ref: '#/components/schemas/dspSharedAudienceTarget' description: The updated AudienceTarget data. messagesUpdateCampaignError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesUpdateCampaignErrorAPIErrorInfo' messagesUpdateCampaignErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesUpdateCampaignErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesUpdateCampaignErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN - CAMPAIGN_SKAN_MUST_BE_UNSET_FOR_NON_IOS_CAMPAIGN - CAMPAIGN_SKAN_MUST_BE_SET_FOR_IOS_CAMPAIGN - CAMPAIGN_SKAN_CUSTOM_OPTIONS_REQUIRED - CAMPAIGN_TYPE_TRACKING_LINK_REQUIRED - CAMPAIGN_TYPE_LANDING_URL_NOT_ALLOWED - CAMPAIGN_TYPE_LANDING_URL_REQUIRED - CAMPAIGN_TYPE_TRACKING_LINK_NOT_ALLOWED - CAMPAIGN_TYPE_CANNOT_CREATE_FOR_NON_APP_PRODUCT - CAMPAIGN_TYPE_REQUIRES_APP_PROPERTIES - CAMPAIGN_NO_VALID_TRACKING_COMPANY - CAMPAIGN_SKAN_INVALID_GOAL_ACTION - CAMPAIGN_NO_REVENUE_FOR_EVENT - CAMPAIGN_ALREADY_ARCHIVED - CAMPAIGN_CANNOT_ENABLE_WITH_DISABLED_PAYOUT_ITEM - CAMPAIGN_NO_ENABLED_CREATIVE_GROUP - CAMPAIGN_CANNOT_ENABLE_FOR_NON_PAYABLE_ADVERTISER - CAMPAIGN_BUDGET_REQUIRED - CAMPAIGN_ZERO_BUDGET_AE_CAMPAIGN_NOT_DISABLED - CAMPAIGN_TARGET_DUPLICATED_AD_PLATFORM - CAMPAIGN_AD_PLATFORMS_SHOULD_BE_SUPERSET_OF_AD_GROUPS - CAMPAIGN_TYPE_CANNOT_TARGET_MULTIPLE_OSES default: ERROR_REASON_UNKNOWN description: " - CAMPAIGN_SKAN_MUST_BE_UNSET_FOR_NON_IOS_CAMPAIGN: Cannot specify skadn_input for non IOS campaign.\n\ \ - CAMPAIGN_SKAN_MUST_BE_SET_FOR_IOS_CAMPAIGN: Must specify skadn_input for IOS campaign.\n - CAMPAIGN_SKAN_CUSTOM_OPTIONS_REQUIRED:\ \ custom_options must be set for skadn_input.\n - CAMPAIGN_TYPE_TRACKING_LINK_REQUIRED: tracking_link_id is required\ \ for APP installs or re-engagement type campaign.\n - CAMPAIGN_TYPE_LANDING_URL_NOT_ALLOWED: landing_url is not allowed\ \ for APP installs or re-engagement type campaign.\n - CAMPAIGN_TYPE_LANDING_URL_REQUIRED: landing_url is required\ \ for WEB type campaign.\n - CAMPAIGN_TYPE_TRACKING_LINK_NOT_ALLOWED: campaign.tracking_link_id is not allowed for\ \ WEB type campaign.\n - CAMPAIGN_TYPE_CANNOT_CREATE_FOR_NON_APP_PRODUCT: Specified campaign type cannot have non\ \ APP type product.\n - CAMPAIGN_TYPE_REQUIRES_APP_PROPERTIES: Specified campaign type should have APP properties\ \ under the Product.\n - CAMPAIGN_NO_VALID_TRACKING_COMPANY: Creating campaign has invalid tracking company information.\n\ Input tracking link id should be set or target Product should have postback integration.\n - CAMPAIGN_SKAN_INVALID_GOAL_ACTION:\ \ The specified goal action is not valid event for SKAdNetwork.\n - CAMPAIGN_NO_REVENUE_FOR_EVENT: The specified goal\ \ action does not have revenue range.\n - CAMPAIGN_ALREADY_ARCHIVED: The target campaign is already archived.\n -\ \ CAMPAIGN_CANNOT_ENABLE_WITH_DISABLED_PAYOUT_ITEM: Cannot enable the campaign with disabled PayoutItem.\n - CAMPAIGN_NO_ENABLED_CREATIVE_GROUP:\ \ Cannot enable the campaign with no enabled CreativeGroup with Creatives.\n - CAMPAIGN_CANNOT_ENABLE_FOR_NON_PAYABLE_ADVERTISER:\ \ Cannot enable a campaign whose advertiser is not ready for billing.\n - CAMPAIGN_BUDGET_REQUIRED: Campaign budget\ \ is required.\n - CAMPAIGN_ZERO_BUDGET_AE_CAMPAIGN_NOT_DISABLED: Campaign should be disabled if budget_ratio_percent\ \ of audience extension is 0% or 100%.\n - CAMPAIGN_TARGET_DUPLICATED_AD_PLATFORM: Campaign has duplicated targeting\ \ ad platform.\n - CAMPAIGN_AD_PLATFORMS_SHOULD_BE_SUPERSET_OF_AD_GROUPS: Campaign's targeting ad platforms should\ \ be superset of AdGroups'.\n - CAMPAIGN_TYPE_CANNOT_TARGET_MULTIPLE_OSES: Given campaign type cannot target multiple\ \ OSes." messagesUpdateCampaignResponse: type: object properties: campaign: $ref: '#/components/schemas/dspCampaign' description: The updated Campaign data. postback_integration_status: $ref: '#/components/schemas/dspPostbackIntegrationStatus' description: The postback integration status. messagesUpdateCreativeError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesUpdateCreativeErrorAPIErrorInfo' messagesUpdateCreativeErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesUpdateCreativeErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesUpdateCreativeErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN - CREATIVE_SOURCE_TYPE_MISMATCH - CREATIVE_RESTRICTED_UPDATE_FIELDS default: ERROR_REASON_UNKNOWN title: "- CREATIVE_SOURCE_TYPE_MISMATCH: mismatch on creative.type and creative.source type\n - CREATIVE_RESTRICTED_UPDATE_FIELDS:\ \ given fields are not updatable;" messagesUpdateCreativeGroupError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesUpdateCreativeGroupErrorAPIErrorInfo' messagesUpdateCreativeGroupErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesUpdateCreativeGroupErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesUpdateCreativeGroupErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN - CREATIVE_GROUP_FEATURE_TYPE_NOT_MATCH_CREATIVE_FEATURE_TYPE - CREATIVE_GROUP_NEEDS_PRODUCT - CREATIVE_GROUP_STATUS_CHANGE_NOT_ALLOWED - CREATIVE_GROUP_VIDEO_AD_EVENT_TRACKERS_EXCEED_LIMIT default: ERROR_REASON_UNKNOWN description: " - CREATIVE_GROUP_FEATURE_TYPE_NOT_MATCH_CREATIVE_FEATURE_TYPE: The feature type of Creative should match\ \ the feature type of Creative Group.\n - CREATIVE_GROUP_NEEDS_PRODUCT: CreativeGroup with TrackingLink or LandingUrl\ \ needs Product.\n - CREATIVE_GROUP_STATUS_CHANGE_NOT_ALLOWED: Change to requested status is not allowed.\n - CREATIVE_GROUP_VIDEO_AD_EVENT_TRACKERS_EXCEED_LIMIT:\ \ The number of trackers used from VideoAdEventTrackers exceeds limit. The limit is up to 3 per event." messagesUpdateCreativeGroupResponse: type: object properties: creative_group: $ref: '#/components/schemas/dspCreativeGroup' description: The updated CreativeGroup data. creatives: type: array items: type: object $ref: '#/components/schemas/dspCreative' description: The Creatives in the updated CreativeGroups. tracking_link: $ref: '#/components/schemas/dspTrackingLink' description: The TrackingLink used in the retrieved CreativeGroup. messagesUpdateCreativeResponse: type: object properties: creative: $ref: '#/components/schemas/dspCreative' description: The updated Creative data. messagesUpdateCustomerSetError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesUpdateCustomerSetErrorAPIErrorInfo' messagesUpdateCustomerSetErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesUpdateCustomerSetErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesUpdateCustomerSetErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN - CUSTOMER_SET_INVALID_DATA_FILE_PATH - CUSTOMER_SET_DATA_FILE_PATH_AD_ACCOUNT_MISMATCH - CUSTOMER_SET_DATA_FILE_PATH_INVALID_ASSET_KIND - CUSTOMER_SET_DATA_FILE_PATH_MISSING_FILE_NAME - CUSTOMER_SET_MANIPULATION_NOT_ALLOWED default: ERROR_REASON_UNKNOWN description: " - CUSTOMER_SET_INVALID_DATA_FILE_PATH: Data file path cannot be recognized. It should be in format https://cdn-f.adsmoloco.com/{ad_account_id}/csv/{filename}\n\ \ - CUSTOMER_SET_DATA_FILE_PATH_AD_ACCOUNT_MISMATCH: ad_account_id on data path mismatch with request. It should be\ \ in format https://cdn-f.adsmoloco.com/{ad_account_id}/csv/{filename}\n - CUSTOMER_SET_DATA_FILE_PATH_INVALID_ASSET_KIND:\ \ asset kind on data path should be 'csv'. It should be in format https://cdn-f.adsmoloco.com/{ad_account_id}/csv/{filename}\n\ \ - CUSTOMER_SET_DATA_FILE_PATH_MISSING_FILE_NAME: file name on asset kind is missing. It should be in format https://cdn-f.adsmoloco.com/{ad_account_id}/csv/{filename}\n\ \ - CUSTOMER_SET_MANIPULATION_NOT_ALLOWED: CustomerSet manipulation (creation, update, deletion) is only allowed when\ \ data source is data file path." messagesUpdateCustomerSetResponse: type: object properties: customer_set: $ref: '#/components/schemas/dspCustomerSet' description: The updated CustomerSet. messagesUpdatePasswordError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesUpdatePasswordErrorAPIErrorInfo' messagesUpdatePasswordErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesUpdatePasswordErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesUpdatePasswordErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN - USER_UPDATE_NOT_ALLOWED - USER_INVALID_PASSWORD - USER_CANNOT_USE_PREVIOUS_PASSWORD default: ERROR_REASON_UNKNOWN description: " - USER_UPDATE_NOT_ALLOWED: The user can't update other user's name or password.\n - USER_INVALID_PASSWORD:\ \ User password is invalid.\nPassword must be at least 12 characters and contain at least one number, uppercase letter,\ \ lowercase letter and special character.\n - USER_CANNOT_USE_PREVIOUS_PASSWORD: Users cannot reuse previous password." messagesUpdatePasswordRequest: type: object properties: current_password: type: string description: The current password. new_password: type: string description: 'The new password. Password must be at least 12 characters and contain at least one number, uppercase letter, lowercase letter and special character.' required: - current_password - new_password messagesUpdatePasswordResponse: type: object messagesUpdateProductError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesUpdateProductErrorAPIErrorInfo' messagesUpdateProductErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesUpdateProductErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesUpdateProductErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN - PRODUCT_INVALID_APP_RATING default: ERROR_REASON_UNKNOWN description: ' - PRODUCT_INVALID_APP_RATING: The product''s app property has invalid rating.' messagesUpdateProductResponse: type: object properties: product: $ref: '#/components/schemas/dspProduct' description: The updated Product data. postback_integration_statuses: type: array items: type: object $ref: '#/components/schemas/dspPostbackIntegrationStatus' description: The postback integration status. messagesUpdateProductSKANConversionConfigError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesUpdateProductSKANConversionConfigErrorAPIErrorInfo' messagesUpdateProductSKANConversionConfigErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesUpdateProductSKANConversionConfigErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesUpdateProductSKANConversionConfigErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN - PRODUCT_EMPTY_REVENUE_INTERVAL_FOR_SAME_EVENT_MUST_BE_UNIQUE - PRODUCT_INVALID_CONVERSION_VALUE - PRODUCT_INVALID_REVENUE_INTERVAL - PRODUCT_NON_CONSECUTIVE_CONVERSION_VALUE_FOR_SAME_EVENTS - PRODUCT_CONVERSION_VALUE_MUST_START_AFTER_PREVIOUS_RANGE - PRODUCT_INVALID_PURCHASE_VALUE - PRODUCT_INVALID_EVENT_COUNTER - PRODUCT_INVALID_HOURS_FROM_INSTALL - CAMPAIGN_SKAN_COOLDOWN_TIME_NOT_PASSED default: ERROR_REASON_UNKNOWN description: " - PRODUCT_EMPTY_REVENUE_INTERVAL_FOR_SAME_EVENT_MUST_BE_UNIQUE: Event without revenue value should be\ \ unique.\n - PRODUCT_INVALID_CONVERSION_VALUE: Invalid conversion value.\n - PRODUCT_INVALID_REVENUE_INTERVAL: Invalid\ \ revenue interval.\n - PRODUCT_NON_CONSECUTIVE_CONVERSION_VALUE_FOR_SAME_EVENTS: Conversion values should be consecutive\ \ for the same event name.\n - PRODUCT_CONVERSION_VALUE_MUST_START_AFTER_PREVIOUS_RANGE: Range min value cannot be\ \ smaller than previous range's max value\n - PRODUCT_INVALID_PURCHASE_VALUE: At least 4 Purchase Value should be\ \ registered for each event.\n - PRODUCT_INVALID_EVENT_COUNTER: The event counter should be larger than 0.\n - PRODUCT_INVALID_HOURS_FROM_INSTALL:\ \ The hours from install should be larger than 0.\n - CAMPAIGN_SKAN_COOLDOWN_TIME_NOT_PASSED: SKAN campaigns must\ \ be stopped before 72 hours before any changes." messagesUpdateProductSKANConversionConfigResponse: type: object properties: skan_conversion_config: $ref: '#/components/schemas/MmpIntegrationConversionValueConfigurationItem' messagesUpdateTrackingLinkError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesUpdateTrackingLinkErrorAPIErrorInfo' messagesUpdateTrackingLinkErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesUpdateTrackingLinkErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesUpdateTrackingLinkErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN - TRACKING_LINK_INVALID_OS_TYPE default: ERROR_REASON_UNKNOWN description: ' - TRACKING_LINK_INVALID_OS_TYPE: The tracking link has invalid OS type.' messagesUpdateTrackingLinkResponse: type: object properties: tracking_link: $ref: '#/components/schemas/dspTrackingLink' description: The updated TrackingLink data. validation_status: $ref: '#/components/schemas/messagesTrackingLinkValidationStatus' description: 'The validation status of created tracking link. If the status is WARNING, the tracking link has created but has not recommended values. Please check the details using "Validate a TrackingLink" API.' messagesUpdateUserError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesUpdateUserErrorAPIErrorInfo' messagesUpdateUserErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesUpdateUserErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesUpdateUserErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN - USER_UPDATE_NOT_ALLOWED default: ERROR_REASON_UNKNOWN description: ' - USER_UPDATE_NOT_ALLOWED: The user can''t update other user''s name or password.' messagesUpdateUserResponse: type: object properties: user: $ref: '#/components/schemas/dspUser' description: The user. messagesUserWithInfo: type: object properties: user: $ref: '#/components/schemas/dspUser' description: The user. signed_up: type: boolean description: Signed up status of user. roles: type: array items: type: object $ref: '#/components/schemas/dspRole' description: List of roles the user has. messagesValidateTrackingLinkError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesValidateTrackingLinkErrorAPIErrorInfo' messagesValidateTrackingLinkErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesValidateTrackingLinkErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string messagesValidateTrackingLinkErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN - TRACKING_LINK_NO_LINKS_TO_VALIDATE default: ERROR_REASON_UNKNOWN description: ' - TRACKING_LINK_NO_LINKS_TO_VALIDATE: No links to validate. Least one of click_through_link or view_through_link must be set.' messagesValidateTrackingLinkResponse: type: object properties: status: $ref: '#/components/schemas/messagesValidateTrackingLinkResponseStatus' description: Validation status. validation_errors: type: array items: type: object $ref: '#/components/schemas/ValidateTrackingLinkResponseTrackingLinkValidationError' description: 'List of errors occurred on validation. Will be supported until v1.2.' validation_errors_click_through_link: type: array items: type: object $ref: '#/components/schemas/ValidateTrackingLinkResponseTrackingLinkValidationError' description: List of errors occurred on click_through_link. validation_errors_view_through_link: type: array items: type: object $ref: '#/components/schemas/ValidateTrackingLinkResponseTrackingLinkValidationError' description: List of errors occurred on view_through_link. validation_warnings_click_through_link: type: array items: type: object $ref: '#/components/schemas/ValidateTrackingLinkResponseTrackingLinkValidationError' description: List of warnings occurred on click_through_link. validation_warnings_view_through_link: type: array items: type: object $ref: '#/components/schemas/ValidateTrackingLinkResponseTrackingLinkValidationError' description: List of warnings occurred on view_through_link. messagesValidateTrackingLinkResponseStatus: type: string enum: - UNKNOWN_VALIDATION_STATUS - PASSED - FAILED default: UNKNOWN_VALIDATION_STATUS description: "Status enumerates the status of validation.\n\n - PASSED: No errors found on validation.\n - FAILED: The\ \ link has some invalid values. Detailed error can be found at validation_errors." protobufAny: type: object properties: '@type': type: string additionalProperties: {}