openapi: 3.0.0 info: title: Management API description: MOLOCO RMP Management API provides functionalities for MOLOCO RMP systems. version: '1.0' contact: name: Moloco Inc. url: https://www.molocoads.com tags: - name: RmpManagementApi paths: /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts: get: summary: ListAdAccounts description: List all the ad accounts on the platform. operationId: RmpManagementApi_ListAdAccounts responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicListAdAccountsResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string tags: - AdAccount post: summary: CreateAdAccount description: Create a new ad account. operationId: RmpManagementApi_CreateAdAccount responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicCreateAdAccountResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: ad_account: $ref: '#/components/schemas/publicCreateAdAccountRequestAdAccountInfo' description: CreateAdAccount request. required: - ad_account additionalProperties: true required: true tags: - AdAccount /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}: get: summary: ReadAdAccount description: Read a ad account. operationId: RmpManagementApi_ReadAdAccount responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicReadAdAccountResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string - name: ad_account_id description: AdAccount id. in: path required: true schema: type: string tags: - AdAccount put: summary: UpdateAdAccount description: Update an ad account. operationId: RmpManagementApi_UpdateAdAccount responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicUpdateAdAccountResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string - name: ad_account_id description: AdAccount id. in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: ad_account: $ref: '#/components/schemas/publicUpdateAdAccountRequestAdAccountInfo' description: UpdateAdAccount request. required: - ad_account additionalProperties: true required: true tags: - AdAccount /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/audience-report: post: summary: QueryAudienceSummary description: Read summarized reporting information of campaign with respect to audience targeting. operationId: RmpManagementApi_QueryAudienceSummary responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicReadAudienceReportSummaryResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string - name: ad_account_id description: AdAccount id. in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: date_start: type: string description: Date in 'YYYY-MM-DD' when summary begins. Inclusive. The allowed maximum duration for the date range is 30 days. date_end: type: string description: Date in 'YYYY-MM-DD' when summary ends. Inclusive. The allowed maximum duration for the date range is 30 days. limit: type: string format: int64 description: Maximum number of rows to be returned. Cannot exceed 50,000. description: ReadAudienceReportSummary request. required: - date_start - date_end additionalProperties: true required: true tags: - Report /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/campaign-forecast: post: summary: ReadCampaignForecast description: Show campaign forecast metrics such as click, imp, and purchase when an advertiser sets up their campaign. operationId: RmpManagementApi_ReadCampaignForecast responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicReadCampaignForecastResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string - name: ad_account_id description: AdAccount id. It is passed as a path parameter. in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: forecast_campaign: $ref: '#/components/schemas/ReadCampaignForecastRequestForecastCampaignParams' description: ReadCampaignForecast request. required: - forecast_campaign additionalProperties: true required: true tags: - Intelligence /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/campaign-guidances: get: summary: ReadCampaignGuidance description: Read guidance for a reasonable campaign setup. operationId: RmpManagementApi_ReadCampaignGuidance responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicReadCampaignGuidanceResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string - name: ad_account_id description: AdAccount id. in: path required: true schema: type: string - name: campaign_id description: Campaign id must be specified when requesting guidance for an existing campaign to be guided according to the campaign history. in: query required: false schema: type: string - name: goal_type description: Campaign goal type must be specified when requesting guidance for a new campaign to be selectively guided according to the goal. in: query required: false schema: type: string enum: - FIXED_CPC - OPTIMIZE_ROAS - FIXED_COMMISSION_RATE default: UNKNOWN_CAMPAIGN_GOAL_TYPE - name: ad_type description: Campaign ad type must be specified when requesting guidance for a new campaign. in: query required: false schema: type: string enum: - ITEM default: UNKNOWN_AD_TYPE tags: - Intelligence /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/campaign-reviews: get: summary: ListCampaignReviews description: List campaign reviews. operationId: RmpManagementApi_ListCampaignReviews responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicListCampaignReviewsResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string - name: ad_account_id description: The id of the ad account that owns this campaign review. in: path required: true schema: type: string - name: campaign_id description: The id of the campaign that owns this campaign review. in: query required: false schema: type: string - name: brand_entity_type description: Brand entity type to be listed. Default is ALL type. in: query required: false schema: type: string enum: - ALL - ASSET - LANDING_PAGE default: ALL - name: brand_entity_ids description: Lists campaign reviews for given entity ids. in: query required: false explode: true schema: type: array items: type: string tags: - Campaign post: summary: CreateCampaignReview description: Create a campaign component's review. It generates the review for the given campaign's resources such as assets or landing page operationId: RmpManagementApi_CreateCampaignReview responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicCreateCampaignReviewResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string - name: ad_account_id description: The id of the ad account that owns this campaign review. in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: campaign_id: type: string description: The id of the campaign that owns this campaign review. brand_entity_type: $ref: '#/components/schemas/commonBrandEntityType' brand_entity_id: type: string description: Brand entity id of the review. It must be asset id or landing page id. review_status: $ref: '#/components/schemas/commonReviewStatus' rejection_reason: type: string description: If the review status is rejected, this field must contain the reason for rejection. description: CreateCampaignReview request. required: - campaign_id - brand_entity_type - brand_entity_id - review_status additionalProperties: true required: true tags: - Campaign /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/campaign-reviews-bulk: put: summary: UpdateCampaignReviewsBulk description: Update campaign components' reviews in bulk. operationId: RmpManagementApi_UpdateCampaignReviewsBulk responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicUpdateCampaignReviewsBulkResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string - name: ad_account_id description: The id of the ad account that owns this campaign review. in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: campaign_id: type: string description: The id of the campaign that owns this campaign review. campaign_reviews: type: array items: $ref: '#/components/schemas/v1CampaignReview' description: Campaign reviews bulk update information. description: UpdateCampaignReviewsBulk request. required: - campaign_id - campaign_reviews additionalProperties: true required: true tags: - Campaign /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/campaign-reviews/{brand_entity_id}: put: summary: UpdateCampaignReview description: Update a campaign component's review. It updates the review status of the given campaign's resources such as assets or landing page operationId: RmpManagementApi_UpdateCampaignReview responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicUpdateCampaignReviewResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string - name: ad_account_id description: The id of the ad account that owns this campaign review. in: path required: true schema: type: string - name: brand_entity_id description: Brand entity id of the review. It must be asset id or landing page id. in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: campaign_id: type: string description: The id of the campaign that owns this campaign review. campaign_review: $ref: '#/components/schemas/v1CampaignReview' description: UpdateCampaignReview request. required: - campaign_id - campaign_review additionalProperties: true required: true tags: - Campaign /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/campaigns: get: summary: ListCampaigns description: List all the campaigns of an ad account. operationId: RmpManagementApi_ListCampaigns responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicListCampaignsResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string - name: ad_account_id description: AdAccount id. in: path required: true schema: type: string - name: without_catalog_item_ids description: Option to exclude catalog item ids which belonging to the campaign. It is passed as a query parameter. in: query required: false schema: type: boolean tags: - Campaign post: summary: CreateCampaign description: Create a campaign of an ad account. The daily_budget field is deprecated. Please use the budget field as an alternative. operationId: RmpManagementApi_CreateCampaign responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicCreateCampaignResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string - name: ad_account_id description: AdAccount id. in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: campaign: $ref: '#/components/schemas/publicCreateCampaignRequestCampaignParams' option: $ref: '#/components/schemas/v1CampaignUpsertOption' description: CreateCampaign request. required: - campaign additionalProperties: true required: true tags: - Campaign /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/campaigns/{campaign_id}: get: summary: ReadCampaign description: Read a campaign of an ad account. operationId: RmpManagementApi_ReadCampaign responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicReadCampaignResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string - name: ad_account_id description: AdAccount id. in: path required: true schema: type: string - name: campaign_id description: Campaign id. in: path required: true schema: type: string tags: - Campaign put: summary: UpdateCampaign description: Update a campaign of an ad account. operationId: RmpManagementApi_UpdateCampaign responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicUpdateCampaignResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string - name: ad_account_id description: AdAccount id. in: path required: true schema: type: string - name: campaign_id description: Campaign id. in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: campaign: $ref: '#/components/schemas/publicUpdateCampaignRequestCampaignParams' option: $ref: '#/components/schemas/v1CampaignUpsertOption' description: UpdateCampaign request. required: - campaign additionalProperties: true required: true tags: - Campaign /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/campaigns/{campaign_id}/change-log-items: post: summary: QueryCampaignItemsHistory description: Query items' history in the campaign. operationId: RmpManagementApi_QueryCampaignChangeLogItems responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicQueryCampaignChangeLogItemsResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string - name: ad_account_id description: AdAccount id. in: path required: true schema: type: string - name: campaign_id description: Campaign id. in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: updated_at: type: string format: date-time description: Updated timestamp of Campaign. type: $ref: '#/components/schemas/v1ChangeLogItemsType' page_index: type: integer format: int32 description: Index of the page to be returned. If empty, the default page_index will be 1. page_size: type: integer format: int32 description: Number of items to be returned on this page index. The maximum number is 5000. search_keyword: type: string description: Search keyword. Specific string in the item id/title to search for. order_by: $ref: '#/components/schemas/v1ChangeLogItemsOrderBy' description: Request message of QueryCampaignItemsHistory. required: - updated_at - type additionalProperties: true required: true tags: - ChangeHistory /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/campaigns/{campaign_id}/change-logs: post: summary: QueryCampaignHistory description: Query campaign history. operationId: RmpManagementApi_QueryCampaignChangeLogs responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicQueryCampaignChangeLogsResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string - name: ad_account_id description: AdAccount id. in: path required: true schema: type: string - name: campaign_id description: Campaign id. in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: filters: type: array items: $ref: '#/components/schemas/v1EntityChangeLogFilter' description: Filters can be used to retrieve change logs that match specific entity change methods and field names. If multiple filters are provided, the change logs returned will include those that satisfy any of the filter conditions. start_time: type: string format: date-time description: Start time in RFC3339 format, e.g. "2017-04-01T12:34:56+00:00" end_time: type: string format: date-time description: End time in RFC3339 format, e.g. "2017-05-01-T21:09:08+00:00" page_index: type: integer format: int32 description: 'Index of the page to be returned. Default: 1' page_size: type: integer format: int32 description: 'Number of items to be returned on this page index. The maximum number is 5000. Default: 10' order_by: $ref: '#/components/schemas/v1ChangeLogOrderBy' description: Request message of QueryCampaignChangeHistory. additionalProperties: true required: true tags: - ChangeHistory /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/campaigns/{campaign_id}/items: post: summary: QueryItemsCampaign description: Query catalog items associated with the campaign operationId: RmpManagementApi_QueryItemsCampaign responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicItemSearchResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string - name: ad_account_id description: AdAccount id. in: path required: true schema: type: string - name: campaign_id description: Campaign id. in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: page_index: type: integer format: int32 description: Index of the page to be returned. If empty, the default page_index will be 1. page_size: type: integer format: int32 description: Number of items to be returned on this page index. The maximum number is 5000. search_keyword: type: array items: type: string description: Search keyword. Specific string in the product id/title/category to search for. order_by: type: array items: $ref: '#/components/schemas/publicItemSearchRequestOrderBy' description: Sort options for the result. If empty, the default value will be PRICE DESC. filter: type: array items: $ref: '#/components/schemas/commonfilterQueryFilter' description: Query Filter. item_ids: type: array items: type: string description: List of item ids. description: ItemSearch request. required: - page_index - page_size additionalProperties: true required: true tags: - Campaign /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/credits: get: summary: ListCredits description: ' List credits of the ad account that has spending limit.' operationId: RmpManagementApi_ListCredits responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicListCreditsResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: The Platform id. in: path required: true schema: type: string - name: ad_account_id description: The AdAccount id. in: path required: true schema: type: string tags: - SpendingLimit /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/credits/{credit_id}/account-history: post: summary: QueryCreditsHistory description: Query credits history. To be used for spending limit credit. operationId: RmpManagementApi_QueryCreditHistory responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicQueryCreditHistoryResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string - name: ad_account_id description: AdAccount id. in: path required: true schema: type: string - name: credit_id description: Credit ID. in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: start_time: type: string format: date-time description: Start time in RFC3339 format, e.g. "2017-04-01T12:34:56+00:00" end_time: type: string format: date-time description: End time in RFC3339 format, e.g. "2017-05-01-T21:09:08+00:00" page_index: type: integer format: int32 description: 'Index of the page to be returned. Default: 1' page_size: type: integer format: int32 description: 'Number of items to be returned on this page index. The maximum number is 5000. Default: 10' order_by: $ref: '#/components/schemas/v1ChangeLogOrderBy' description: QueryCreditHistory request for Spending Limit. additionalProperties: true required: true tags: - ChangeHistory deprecated: true /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/credits/{credit_id}/top-up/{request_id}: put: summary: TopUpCredits description: Top up an amount of money (VAT exclusive) to the credits balance. operationId: RmpManagementApi_TopUpCredit responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicTopUpCreditResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: The Platform id. in: path required: true schema: type: string - name: ad_account_id description: The AdAccount id. in: path required: true schema: type: string - name: credit_id description: The Credit id. in: path required: true schema: type: string - name: request_id description: The TopUp request Id. For retries, the same request_id should used again to prevent multiple requests. in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: top_up: $ref: '#/components/schemas/rmpcommonMoneyMicro' comment: type: string description: A comment for transaction. Optional. description: TopUpCredit request. required: - top_up additionalProperties: true required: true tags: - SpendingLimit /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/credits/{credit_id}/transaction-history: post: summary: QuerySpendingLimitCreditHistory description: Query spending limit credits history. operationId: RmpManagementApi_QuerySpendingLimitCreditHistory responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicQuerySpendingLimitCreditHistoryResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string - name: ad_account_id description: Ad Account ID. in: path required: true schema: type: string - name: credit_id description: Credit ID. in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: start_time: type: string format: date-time description: Start time in RFC3339 format, e.g. "2017-04-01T12:34:56+00:00" end_time: type: string format: date-time description: End time in RFC3339 format, e.g. "2017-05-01-T21:09:08+00:00" cursor: type: string description: Cursor for pagination. Required after the first request. limit: type: integer format: int64 default: '10' description: 'Number of items to be returned. Default: 10, Maximum value: 5000' order_by: $ref: '#/components/schemas/v1ChangeLogOrderBy' additionalProperties: true required: true tags: - SpendingLimit /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/credits/{credit_id}/withdraw/{request_id}: put: summary: WithdrawCredits description: Withdraw an amount of money (VAT exclusive) from the credits balance of the ad account. operationId: RmpManagementApi_WithdrawCredit responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicWithdrawCreditResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: The Platform id. in: path required: true schema: type: string - name: ad_account_id description: The AdAccount id. in: path required: true schema: type: string - name: credit_id description: The Credit id. in: path required: true schema: type: string - name: request_id description: The Withdraw request Id. For retries, the same request_id should be used again to prevent multiple requests. in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: withdraw: $ref: '#/components/schemas/rmpcommonMoneyMicro' comment: type: string description: A comment for transaction. Optional. description: WithdrawCredit request. required: - withdraw additionalProperties: true required: true tags: - SpendingLimit /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/custom-target-keys-bulk: post: summary: ReadCustomTargetKeysBulk description: Read custom target keys in bulk. operationId: RmpManagementApi_ReadCustomTargetKeysBulk responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicReadCustomTargetKeysBulkResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string - name: ad_account_id description: The id of the ad account to query custom target keys. It is passed as a path parameter. in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: ad_type: $ref: '#/components/schemas/rmpcommonAdType' custom_target_key_ids: type: array items: type: string description: Custom target key ids. description: ReadCustomTargetKeysBulk request. required: - ad_type - custom_target_key_ids additionalProperties: true required: true tags: - CustomTargeting ? /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/custom-target-keys/{custom_target_key_id}/custom-target-values-bulk : post: summary: ReadCustomTargetValuesBulk description: Read custom target values in bulk. operationId: RmpManagementApi_ReadCustomTargetValuesBulk responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicReadCustomTargetValuesBulkResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string - name: ad_account_id description: The id of the ad account to query custom target values. It is passed as a path parameter. in: path required: true schema: type: string - name: custom_target_key_id description: The id of the custom target key. It is passed as a path parameter. in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: ad_type: $ref: '#/components/schemas/rmpcommonAdType' custom_target_value_ids: type: array items: type: string description: Custom target value ids. Exactly one of custom_target_value_ids or custom_target_value_labels must be provided. custom_target_value_labels: type: array items: type: string description: Custom target value labels. Exactly one of custom_target_value_ids or custom_target_value_labels must be provided. description: ReadCustomTargetValuesBulk request. required: - ad_type additionalProperties: true required: true tags: - CustomTargeting /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/image-assets: get: summary: ListImageAssets description: List all the image assets. operationId: RmpManagementApi_ListImageAssets responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicListImageAssetsResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string - name: ad_account_id description: The id of the ad account that owns the image asset. in: path required: true schema: type: string - name: image_asset_type description: Image asset type in: query required: false schema: type: string enum: - UNKNOWN_IMAGE_ASSET_TYPE - BANNER - LOGO default: UNKNOWN_IMAGE_ASSET_TYPE - name: ids in: query required: false explode: true schema: type: array items: type: string tags: - Asset post: summary: CreateImageAsset description: Create image asset operationId: RmpManagementApi_CreateImageAsset responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicCreateImageAssetResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string - name: ad_account_id description: The id of the ad account that owns this image asset. in: path required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object properties: image_asset: description: "Provide a JSON string representing the `image_asset` object.\n\n**Field Details:**\n- **title**\ \ (string, required): A descriptive name of the image asset.\n- **image_asset_type** (string, required):\ \ The type of image asset. Allowed values:\n - `BANNER`\n - `LOGO`\n- **image_url** (object, optional):\ \ Only provide this field when neither `file` parameter nor `object_key` parameter is provided. Details\ \ about the image source:\n - **url** (string): The URL of the image.\n - **file_name** (string): The\ \ file name of the image. e.g., `image.png`.\n\n**Upload Methods (choose only one):**\n1. **Upload by\ \ file**: Use the `file` parameter with the actual image file\n2. **Upload by CDN**: Include the `image_url`\ \ object in this `image_asset` object\n3. **Upload by session**: Include the `object_key` parameter which\ \ is issued from `CreateBulkImageUploadSession` API\n\n**Examples:**\n\n**Example 1: Upload by file**\n\ - Provide the `file` parameter with the image file and omit both `object_key` and `image_url` object in\ \ the `image_asset` object.\n```json\n{\n \"title\": \"Banner Image\",\n \"image_asset_type\": \"BANNER\"\ \n}\n```\n\n**Example 2: Upload by CDN**\n- Omit both `object_key` and `file` parameter and include the\ \ `image_url` object in the `image_asset` object.\n```json\n{\n \"title\": \"Logo Image\",\n \"image_asset_type\"\ : \"LOGO\",\n \"image_url\": {\n \"url\": \"https://example.com/logo.png\",\n \"file_name\": \"\ logo.png\"\n }\n}\n```\n\n**Example 3: Upload by session**\n- Provide the `object_key` parameter and\ \ omit both `file` and `image_url` object in the `image_asset` object.\n```json\n{\n \"title\": \"Banner\ \ Image\",\n \"image_asset_type\": \"BANNER\"\n}\n```" type: string file: description: Provide the image file when using upload by file method. Do not use this parameter if `image_url` object is included in the `image_asset` object or if `object_key` parameter is provided. type: string format: binary object_key: description: 'Provide the object key when using upload by session method. Do not use this parameter if `file` parameter is provided or if `image_url` object is included in the `image_asset` object. The object key can be obtained from `CreateBulkImageUploadSession` API''s response. User need to upload a image file after this API''s response. Please make sure file is uploaded and then request with the object_key. ' type: string required: - image_asset required: true tags: - Asset /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/image-assets/upload-session: post: summary: CreateBulkImageUploadSession description: Create session for bulk image upload operationId: RmpManagementApi_CreateBulkImageUploadSession responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicCreateBulkImageUploadSessionResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Platform identifier. in: path required: true schema: type: string - name: ad_account_id description: Ad account identifier. in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: files: type: array items: $ref: '#/components/schemas/publicCreateBulkImageUploadSessionRequestFileInfo' description: List of files to upload. description: Request to create an upload session for image upload. required: - files additionalProperties: true required: true tags: - Asset /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/image-assets/{image_asset_id}: get: summary: ReadImageAsset description: Read image asset information operationId: RmpManagementApi_ReadImageAsset responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicReadImageAssetResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string - name: ad_account_id description: The id of the ad account that owns this image asset. in: path required: true schema: type: string - name: image_asset_id description: Image asset ID. in: path required: true schema: type: string tags: - Asset /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/item-based-campaign-guidances: post: summary: ReadItemBasedCampaignGuidance description: Get item-based guidance recommendations for campaign optimization based on item performance analysis. operationId: RmpManagementApi_ReadItemBasedCampaignGuidance responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicReadItemBasedCampaignGuidanceResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string - name: ad_account_id description: AdAccount id. in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: guidance_campaign: $ref: '#/components/schemas/ReadItemBasedCampaignGuidanceRequestItemBasedCampaignGuidanceParams' description: ReadItemBasedCampaignGuidance request. additionalProperties: true required: true tags: - Intelligence /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/keyword-report: post: summary: QueryKeywordSummary description: Read summarized reporting information of campaigned keywords. operationId: RmpManagementApi_QueryKeywordSummary responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicReadKeywordReportSummaryResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string - name: ad_account_id description: AdAccount id. in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: date_start: type: string description: Date in 'YYYY-MM-DD' when summary begins. Inclusive. The allowed maximum duration for the date range is 30 days. date_end: type: string description: Date in 'YYYY-MM-DD' when summary ends. Inclusive. The allowed maximum duration for the date range is 30 days. limit: type: string format: int64 description: Maximum number of rows to be returned. Cannot exceed 50,000. description: ReadKeywordReportSummary request. required: - date_start - date_end additionalProperties: true required: true tags: - Report /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/orders-with-line-items: post: summary: UpsertOrderWithLineItems description: Create or update an order along with its associated line items in a single atomic operation. operationId: RmpManagementApi_UpsertOrderWithLineItems responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicUpsertOrderWithLineItemsResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string - name: ad_account_id description: AdAccount id. in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: order: $ref: '#/components/schemas/UpsertOrderWithLineItemsRequestOrderParams' line_items: type: array items: $ref: '#/components/schemas/publicUpsertOrderWithLineItemsRequestLineItemParams' description: List of line item parameters for creation or update. Each line item with an id will be updated; those without an id will be created. description: UpsertOrderWithLineItems request. Creates or updates an order along with its associated line items in a single atomic operation. required: - order - line_items additionalProperties: true required: true tags: - ReservedDisplay /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/orders/{order_id}: get: summary: ReadOrder description: Read order information with line items. operationId: RmpManagementApi_ReadOrder responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicReadOrderResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform. It is passed as a path parameter. in: path required: true schema: type: string - name: ad_account_id description: The id of the ad account. It is passed as a path parameter. in: path required: true schema: type: string - name: order_id description: The id of the order. It is passed as a path parameter. in: path required: true schema: type: string tags: - ReservedDisplay ? /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/orders/{order_id}/line-items/{line_item_id}/custom-daily-report : get: summary: QueryCustomTargetDailySummary description: Retrieve the custom targeting daily summary reports for a single line item. operationId: RmpManagementApi_QueryCustomTargetDailySummary2 responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicQueryCustomTargetDailySummaryResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string - name: ad_account_id description: The id of the ad account. It is passed as a path parameter. in: path required: true schema: type: string - name: order_id description: The id of the order. It is passed as a path parameter. in: path required: true schema: type: string - name: line_item_id description: The id of the line item. It is passed as a path parameter. in: path required: true schema: type: string - name: date_range.date_start description: Date in 'YYYY-MM-DD' when summary begins. Inclusive. Note the allowed maximum duration for the date range is 186 days, to cover the period of any entire month. in: query required: false schema: type: string - name: date_range.date_end description: Date in 'YYYY-MM-DD' when summary ends. Inclusive. Note the allowed maximum duration for the date range is 186 days, to cover the period of any entire month. in: query required: false schema: type: string - name: custom_target_key_id description: Custom target key id to retrieve the report. in: query required: false schema: type: string tags: - CustomTargeting post: summary: QueryCustomTargetDailySummary description: Retrieve the custom targeting daily summary reports for a single line item. operationId: RmpManagementApi_QueryCustomTargetDailySummary responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicQueryCustomTargetDailySummaryResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string - name: ad_account_id description: The id of the ad account. It is passed as a path parameter. in: path required: true schema: type: string - name: order_id description: The id of the order. It is passed as a path parameter. in: path required: true schema: type: string - name: line_item_id description: The id of the line item. It is passed as a path parameter. in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: date_range: $ref: '#/components/schemas/commonDateRange' custom_target_key_id: type: string description: Custom target key id to retrieve the report. description: QueryCustomTargetDailySummary request for fetching custom targeting daily reports of a line item. Maximum date range is 91 days. Default order is DATE_ASC. required: - date_range - custom_target_key_id additionalProperties: true required: true tags: - CustomTargeting ? /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/orders/{order_id}/line-items/{line_item_id}/custom-target-keys-with-custom-report-bulk : get: summary: ReadCustomTargetKeysWithCustomReportBulk description: Read the keys that have available report data in bulk. operationId: RmpManagementApi_ReadCustomTargetKeysWithCustomReportBulk responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicReadCustomTargetKeysWithCustomReportBulkResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string - name: ad_account_id description: The id of the ad account. It is passed as a path parameter. in: path required: true schema: type: string - name: order_id description: The id of the order. It is passed as a path parameter. in: path required: true schema: type: string - name: line_item_id description: The id of the line item. It is passed as a path parameter. in: path required: true schema: type: string tags: - CustomTargeting /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/orders/{order_id}/line-items/{line_item_id}/daily-report: post: summary: QueryLineItemDailySummary description: Retrieve the daily summary reports for a single line item. operationId: RmpManagementApi_QueryLineItemDailySummary responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicQueryLineItemDailySummaryResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform. It is passed as a path parameter. in: path required: true schema: type: string - name: ad_account_id description: The id of the ad account. It is passed as a path parameter. in: path required: true schema: type: string - name: order_id description: The id of the order. It is passed as a path parameter. in: path required: true schema: type: string - name: line_item_id description: The id of the line item. It is passed as a path parameter. in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: date_range: $ref: '#/components/schemas/commonDateRange' description: QueryLineItemDailySummary request. Retrieve the daily summary reports for a single line item. required: - date_range additionalProperties: true required: true tags: - ReservedDisplay /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/placement-report: post: summary: QueryPlacementSummary description: Read summarized reporting information of campaign with respect to placement targeting. operationId: RmpManagementApi_QueryPlacementSummary responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicReadPlacementReportSummaryResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string - name: ad_account_id description: AdAccount id. in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: date_start: type: string description: Date in 'YYYY-MM-DD' when summary begins. Inclusive. The allowed maximum duration for the date range is 30 days. date_end: type: string description: Date in 'YYYY-MM-DD' when summary ends. Inclusive. The allowed maximum duration for the date range is 30 days. limit: type: string format: int64 description: Maximum number of rows to be returned. Cannot exceed 50,000. description: ReadPlacementReportSummary request. required: - date_start - date_end additionalProperties: true required: true tags: - Report /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/report: post: summary: QueryAdAccountSummary description: Read summarized reporting information of an ad account. operationId: RmpManagementApi_QueryAdAccountSummary responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicQueryAdAccountSummaryResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string - name: ad_account_id description: AdAccount id. in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: timezone: type: string description: Timezone of date_start and date_end. To be deprecated. Only platform timezone is accepted. Must be in IANA timezone name format, e.g. Asia/Seoul. date_start: type: string description: Date in 'YYYY-MM-DD' when summary begins. Inclusive. Note the allowed maximum duration for the date range is 186 days, to cover the period of any entire month. date_end: type: string description: Date in 'YYYY-MM-DD' when summary ends. Inclusive. Note the allowed maximum duration for the date range is 186 days, to cover the period of any entire month. group_by: type: array items: $ref: '#/components/schemas/v1AdAccountSummaryGroupByColumn' description: A list of columns to be grouped by. Please note that among the group_by options, ITEM and CREATIVE cannot be used together order_by: type: array items: $ref: '#/components/schemas/v1AdAccountSummaryOrderByColumn' description: A list of columns to be ordered by. filter: type: array items: $ref: '#/components/schemas/managementv1QueryFilter' description: Query Filter. Only 1 allowed since we only support CAMPAIGN_FILTER. limit: type: string format: int64 description: Maximum number of rows to be returned. Cannot exceed 50,000 description: QueryAdAccountSummary request. required: - date_start - date_end additionalProperties: true required: true tags: - Report /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/spend-caps: get: summary: ListSpendCaps description: List spend caps for an ad account. operationId: RmpManagementApi_ListSpendCaps responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicListSpendCapsResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform. Passed as a path parameter. in: path required: true schema: type: string - name: ad_account_id description: AdAccount id. in: path required: true schema: type: string - name: filter.status description: "Filter by spend cap status.\n\n - SCHEDULED: The SpendCap is not in an Active state due to an unexpected\ \ error case\n Similar to the Scheduled state of a campaign, the SpendCap is in a “reserved” state because its period\ \ has not yet started.\n - INACTIVE: The status when the user manually changes the SpendCap from Active to Inactive.\n\ \ - ACTIVE: The SpendCap is in an Active state. As long as the amount is not depleted, the mapped campaigns can\ \ remain Active and serve ads without issues\n - ENDED: One of the cases where the SpendCap is no longer Active\ \ because its defined period has ended.\n - DEPLETED: The SpendCap has reached its allocated amount (0 remaining).\ \ As a result, the mapped campaigns can no longer remain active and ad serving stops, even though the period itself\ \ has not yet ended.\n - ERROR: Error state. The campaign state does not belong to any states above." in: query required: false schema: type: string enum: - UNKNOWN_SPEND_CAP_STATUS - SCHEDULED - INACTIVE - ACTIVE - ENDED - DEPLETED - ERROR default: UNKNOWN_SPEND_CAP_STATUS tags: - SpendCap post: summary: CreateSpendCap description: Create a spend cap of an ad account. operationId: RmpManagementApi_CreateSpendCap responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicCreateSpendCapResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string - name: ad_account_id description: AdAccount id. in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: title: type: string description: Title of spend cap. Required. schedule: $ref: '#/components/schemas/rmpcommonTimeInterval' budget: $ref: '#/components/schemas/publicCreateSpendCapRequestBudget' comment: type: string description: A reference comment for transaction. Optional. additionalProperties: true required: true tags: - SpendCap /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/spend-caps/{spend_cap_id}: get: summary: ReadSpendCap description: Read a spend cap of an ad account. operationId: RmpManagementApi_ReadSpendCap responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicReadSpendCapResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string - name: ad_account_id description: AdAccount id. in: path required: true schema: type: string - name: spend_cap_id description: Id of the spend cap to be retrieved. in: path required: true schema: type: string tags: - SpendCap put: summary: UpdateSpendCap description: Update a spend cap of an ad account. operationId: RmpManagementApi_UpdateSpendCap responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicUpdateSpendCapResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string - name: ad_account_id description: AdAccount id. in: path required: true schema: type: string - name: spend_cap_id description: Spend Cap id. in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: spend_cap: $ref: '#/components/schemas/UpdateSpendCapRequestSpendCapParams' additionalProperties: true required: true tags: - SpendCap /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/spending-limits: get: summary: ListSpendingLimits description: List all spending limits of an ad account. Currently, an ad account can have a single spending limit. operationId: RmpManagementApi_ListSpendingLimits responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicListSpendingLimitsResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: The Platform id. in: path required: true schema: type: string - name: ad_account_id description: The AdAccount id. in: path required: true schema: type: string tags: - SpendingLimit /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/spending-limits/{spending_limit_id}: get: summary: ReadSpendingLimit description: Read spending limit of the ad account. operationId: RmpManagementApi_ReadSpendingLimit responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicReadSpendingLimitResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: The Platform id. in: path required: true schema: type: string - name: ad_account_id description: The AdAccount id. in: path required: true schema: type: string - name: spending_limit_id description: The Spend Limit id. in: path required: true schema: type: string tags: - SpendingLimit put: summary: UpdateSpendingLimit description: Update a spending limit. operationId: RmpManagementApi_UpdateSpendingLimit responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicUpdateSpendingLimitResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: The Platform id. in: path required: true schema: type: string - name: ad_account_id description: The AdAccount id. in: path required: true schema: type: string - name: spending_limit_id description: The Spend Limit id. in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: update_amount: $ref: '#/components/schemas/rmpcommonMoneyMicro' description: UpdateSpendingLimit request. additionalProperties: true required: true tags: - SpendingLimit /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/state-info: put: summary: UpdateAdAccountStateInfo description: Update an ad account's state info. operationId: RmpManagementApi_UpdateAdAccountStateInfo responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicUpdateAdAccountStateInfoResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string - name: ad_account_id description: AdAccount id. in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: state_info: $ref: '#/components/schemas/UpdateAdAccountStateInfoRequestAdAccountStateInfoParams' description: UpdateAdAccountStateInfo request. required: - state_info additionalProperties: true required: true tags: - AdAccount /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/suggested-items: post: summary: QuerySuggestedItems description: Query suggested catalog items associated with the ad account. Prior to using this API, please get in touch with the RMP associate to ensure correct configuration of this feature. operationId: RmpManagementApi_QuerySuggestedItems responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicItemSearchResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string - name: ad_account_id description: AdAccount id. in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: order_by: type: array items: $ref: '#/components/schemas/publicItemSearchRequestOrderBy' description: Sort options for the result. If empty, the default value will be PRICE DESC. search_keyword: type: array items: type: string description: Search keyword. Specific string in the product id/title/category to search for. filter: type: array items: $ref: '#/components/schemas/commonfilterQueryFilter' description: Query Filter. limit: type: string format: int64 description: Limit option for the result. If empty, the default value will be 10. new_item_timestamp: type: string description: Timestamp for determining whether an item is new. New item refers to an item that has been added since certain timestamp, such as campaign's last updated timestamp. description: SuggestedItemsRequest. additionalProperties: true required: true tags: - Intelligence /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/video-assets: get: summary: ListVideoAssets description: List all the video assets. operationId: RmpManagementApi_ListVideoAssets responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicListVideoAssetsResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string - name: ad_account_id description: The id of the ad account that owns this video asset. in: path required: true schema: type: string - name: ids description: List of video asset IDs. in: query required: false explode: true schema: type: array items: type: string - name: status description: Video asset status. in: query required: false schema: type: string enum: - ALL - PENDING - READY default: ALL tags: - Asset post: summary: CreateVideoAsset description: Create video asset operationId: RmpManagementApi_CreateVideoAsset responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicCreateVideoAssetResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string - name: ad_account_id description: The id of the ad account that owns this video asset. in: path required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object properties: file: description: "Provide the video file when using upload by file method. Do not use this parameter if `object_key`\ \ parameter is provided.\n\n**File Requirements:**\n- **Format**: MP4\n- **Size**: 300MB \n" type: string format: binary object_key: description: Provide the object key when using upload by session method. Do not use this parameter if `file` parameter is provided. The object key can be obtained from `CreateBulkVideoUploadSession` API's response. User need to upload a video file after this API's response. Please make sure file is uploaded and then request with the object_key. type: string tags: - Asset /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/video-assets/upload-session: post: summary: CreateBulkVideoUploadSession description: Create session for bulk video upload operationId: RmpManagementApi_CreateBulkVideoUploadSession responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicCreateBulkVideoUploadSessionResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string - name: ad_account_id description: The id of the ad account that owns this video asset. in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: files: type: array items: $ref: '#/components/schemas/publicCreateBulkVideoUploadSessionRequestFileInfo' description: List of files to upload. description: CreateBulkVideoUploadSession request. required: - files additionalProperties: true required: true tags: - Asset /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/video-assets/{video_asset_id}: get: summary: ReadVideoAsset description: Read video asset information operationId: RmpManagementApi_ReadVideoAsset responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicReadVideoAssetResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string - name: ad_account_id description: The id of the ad account that owns this video asset. in: path required: true schema: type: string - name: video_asset_id description: Video asset ID. in: path required: true schema: type: string tags: - Asset /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/wallets: get: summary: ListWallets description: List all wallets of an ad account. Currently, an ad account can have a single wallet. operationId: RmpManagementApi_ListWallets responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicListWalletsResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: The Platform id. in: path required: true schema: type: string - name: ad_account_id description: The AdAccount id. in: path required: true schema: type: string tags: - Wallet /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/wallets/{wallet_id}/account-history: post: summary: QueryWalletHistory description: Query wallet account history. operationId: RmpManagementApi_QueryWalletAccountHistory responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicQueryWalletAccountHistoryResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string - name: ad_account_id description: AdAccount id. in: path required: true schema: type: string - name: wallet_id description: Wallet id. in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: start_time: type: string format: date-time description: Start time in RFC3339 format, e.g. "2017-04-01T12:34:56+00:00" end_time: type: string format: date-time description: End time in RFC3339 format, e.g. "2017-05-01-T21:09:08+00:00" page_index: type: integer format: int32 description: 'Index of the page to be returned. Default: 1' page_size: type: integer format: int32 description: 'Number of items to be returned on this page index. The maximum number is 5000. Default: 10' order_by: $ref: '#/components/schemas/v1ChangeLogOrderBy' description: QueryWalletAccountHistory request. additionalProperties: true required: true tags: - ChangeHistory deprecated: true /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/wallets/{wallet_id}/top-up/{request_id}: put: summary: TopUpWallet description: Top up an amount of money (VAT exclusive) for the wallet of the ad account. operationId: RmpManagementApi_TopUpWallet responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicTopUpWalletResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: The Platform id. in: path required: true schema: type: string - name: ad_account_id description: The AdAccount id. in: path required: true schema: type: string - name: wallet_id description: The Wallet id. in: path required: true schema: type: string - name: request_id description: The TopUp request ID. For retries, the same request_id should be used again to prevent duplicate requests. Only alphanumeric characters, underscores, and hyphens are allowed, and 8-64 characters are required. in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: top_up: $ref: '#/components/schemas/v1AccountUpdateAmount' comment: type: string description: A comment for transaction. Optional. description: TopUpWallet request. required: - top_up additionalProperties: true required: true tags: - Wallet /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/wallets/{wallet_id}/transaction-history: post: summary: QueryWalletTransactionHistory description: Query wallet transaction history. operationId: RmpManagementApi_QueryWalletTransactionHistory responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicQueryWalletTransactionHistoryResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string - name: ad_account_id description: AdAccount id. in: path required: true schema: type: string - name: wallet_id description: Wallet id. in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: start_time: type: string format: date-time description: Start time in RFC3339 format, e.g. "2017-04-01T12:34:56+00:00" end_time: type: string format: date-time description: End time in RFC3339 format, e.g. "2017-05-01T21:09:08+00:00" cursor: type: string description: Cursor for pagination. If not set, the first page will be returned. limit: type: integer format: int64 default: '10' description: 'Number of items to be returned. The maximum number is 5000. Default: 10' order_by: $ref: '#/components/schemas/v1ChangeLogOrderBy' description: QueryWalletTransactionHistory request. additionalProperties: true required: true tags: - Wallet /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/wallets/{wallet_id}/withdraw/{request_id}: put: summary: WithdrawWallet description: Withdraw an amount of money (VAT exclusive) from a wallet of the ad account. operationId: RmpManagementApi_WithdrawWallet responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicWithdrawWalletResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: The Platform id. in: path required: true schema: type: string - name: ad_account_id description: The AdAccount id. in: path required: true schema: type: string - name: wallet_id description: The Wallet id. in: path required: true schema: type: string - name: request_id description: The Withdraw request ID. For retries, the same request_id should be used again to prevent duplicate requests. Only alphanumeric characters, underscores, and hyphens are allowed, and 8-64 characters are required. in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: withdraw: $ref: '#/components/schemas/v1AccountUpdateAmount' comment: type: string description: A comment for transaction. Optional. description: WithdrawWallet request. required: - withdraw additionalProperties: true required: true tags: - Wallet /rmp/mgmt/v1/platforms/{platform_id}/ad-manager-accounts: get: summary: ListAdManagerAccounts description: List ad manager accounts operationId: RmpManagementApi_ListAdManagerAccounts responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicListAdManagerAccountsResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string tags: - AdManagerAccount post: summary: CreateAdManagerAccount description: Create an ad manager account operationId: RmpManagementApi_CreateAdManagerAccount responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicCreateAdManagerAccountResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: ad_manager_account: $ref: '#/components/schemas/publicCreateAdManagerAccountRequestAdManagerAccountInfo' description: CreateAdManagerAccount request. title: /////////////////////////////////////////////////////// required: - ad_manager_account additionalProperties: true required: true tags: - AdManagerAccount /rmp/mgmt/v1/platforms/{platform_id}/ad-manager-accounts/{ad_manager_account_id}: get: summary: ReadAdManagerAccount description: Read an ad manager account operationId: RmpManagementApi_ReadAdManagerAccount responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicReadAdManagerAccountResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string - name: ad_manager_account_id description: AdManagerAccount id. in: path required: true schema: type: string tags: - AdManagerAccount put: summary: UpdateAdManagerAccount description: Update an ad manager account operationId: RmpManagementApi_UpdateAdManagerAccount responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicUpdateAdManagerAccountResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string - name: ad_manager_account_id description: Identifier of the AdManagerAccount. It is passed as a path parameter. in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: ad_manager_account: $ref: '#/components/schemas/publicUpdateAdManagerAccountRequestAdManagerAccountInfo' description: UpdateAdManagerAccount request. required: - ad_manager_account additionalProperties: true required: true tags: - AdManagerAccount /rmp/mgmt/v1/platforms/{platform_id}/ad-manager-accounts/{ad_manager_account_id}/change-logs: post: summary: QueryAdManagerAccountHistory description: Query the ad manager account history. operationId: RmpManagementApi_QueryAdManagerAccountChangeLogs responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicQueryAdManagerAccountChangeLogsResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string - name: ad_manager_account_id description: AdManagerAccount id. in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: filters: type: array items: $ref: '#/components/schemas/v1EntityChangeLogFilter' description: Filters can be used to retrieve change logs that match specific entity change methods and field names. If multiple filters are provided, the change logs returned will include those that satisfy any of the filter conditions. start_time: type: string format: date-time description: Start time in RFC3339 format, e.g. "2017-04-01T12:34:56+00:00" end_time: type: string format: date-time description: End time in RFC3339 format, e.g. "2017-05-01-T21:09:08+00:00" page_index: type: integer format: int32 description: 'Index of the page to be returned. Default: 1' page_size: type: integer format: int32 description: 'Number of items to be returned on this page index. The maximum number is 5000. Default: 10' order_by: $ref: '#/components/schemas/v1ChangeLogOrderBy' description: QueryAdManagerAccountChangeLogs request. additionalProperties: true required: true tags: - ChangeHistory /rmp/mgmt/v1/platforms/{platform_id}/ad-manager-accounts/{ad_manager_account_id}/report: post: summary: QueryAdManagerAccountSummary description: Read summarized reporting information of an ad manager account. operationId: RmpManagementApi_QueryAdManagerAccountSummary responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicReadAdManagerAccountReportSummaryResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string - name: ad_manager_account_id description: Identifier of the ad manager account who requests management api. It is passed as a path parameter. in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: timezone: type: string description: Timezone of date_start and date_end. If timezone is empty, 'UTC' will be used for the default value. Must be in IANA timezone name format, e.g. Asia/Seoul. date_start: type: string description: Date in 'YYYY-MM-DD' when summary begins. Inclusive. Note the allowed maximum duration for the date range is 186 days, to cover the period of any entire month. date_end: type: string description: Date in 'YYYY-MM-DD' when summary ends. Inclusive. Note the allowed maximum duration for the date range is 186 days, to cover the period of any entire month. group_by: type: array items: $ref: '#/components/schemas/v1AdManagerAccountReportSummaryGroupByColumn' description: A list of columns to be grouped by. limit: type: string format: int64 description: Maximum number of rows to be returned. Cannot exceed 50,000 description: ReadAdManagerAccountReportSummary request. required: - date_start - date_end additionalProperties: true required: true tags: - Report /rmp/mgmt/v1/platforms/{platform_id}/credits-bulk/read: post: summary: QueryCredits description: Query all credits for the platform using spending limit. operationId: RmpManagementApi_QueryCredits responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicQueryCreditsResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: The Platform id. in: path required: true schema: type: string tags: - SpendingLimit /rmp/mgmt/v1/platforms/{platform_id}/custom-target-keys: post: summary: QueryCustomTargetKeys description: Query all available custom target keys for the platform. operationId: RmpManagementApi_QueryCustomTargetKeys responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicQueryCustomTargetKeysResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform. It is passed as a path parameter. in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: cursor: type: string description: Cursor for pagination. Required after the first request. limit: type: integer format: int64 default: '15' description: 'Number of items to be returned. Default: 15, Maximum value: 50' ad_type: $ref: '#/components/schemas/rmpcommonAdType' description: QueryCustomTargetKeys public request. Query all available custom target keys for the platform. required: - ad_type additionalProperties: true required: true tags: - CustomTargeting /rmp/mgmt/v1/platforms/{platform_id}/custom-target-keys/{custom_target_key_id}/custom-target-values: post: summary: QueryCustomTargetValues description: Query all available custom target values for a given key. operationId: RmpManagementApi_QueryCustomTargetValues responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicQueryCustomTargetValuesResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform. It is passed as a path parameter. in: path required: true schema: type: string - name: custom_target_key_id description: Identifier of the custom target key. It is passed as a path parameter. in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: search: type: string description: Search keyword to filter custom target values by label. If provided, only values whose labels contain this keyword will be returned. cursor: type: string description: Cursor for pagination. Required after the first request. limit: type: integer format: int64 default: '15' description: 'Number of items to be returned. Default: 15, Maximum value: 200' description: QueryCustomTargetValues public request. Query all available custom target values for a given key. additionalProperties: true required: true tags: - CustomTargeting /rmp/mgmt/v1/platforms/{platform_id}/data-deletion-requests/user-events: post: summary: CreateUserDataDeletionRequest description: Requests for the User data deletion request. We process the request by deleting the user event data in the batch job. operationId: RmpManagementApi_CreateUserDataDeletionRequest responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicUserDataDeletionResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests data deletion. It is passed as a path parameter. in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: identifiers: type: array items: $ref: '#/components/schemas/UserDataDeletionRequestIdentifier' description: User identifiers to be deleted. description: Data deletion request for user events. required: - identifiers additionalProperties: true required: true tags: - UserDataDeletionRequest /rmp/mgmt/v1/platforms/{platform_id}/data-export/key: post: summary: RotateDataExportKey description: Rotate the data export key. The previous keys associated with the platform's service account would be deleted. operationId: RmpManagementApi_RotateDataExportKey responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicRotateDataExportKeyResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform. It is passed as a path parameter. in: path required: true schema: type: string tags: - DataExport /rmp/mgmt/v1/platforms/{platform_id}/item-status-bulk: post: summary: UpdateItemStatusBulk description: Item Kill Switch API. Immediate removal of specified items from ad serving in bulk. operationId: RmpManagementApi_UpdateItemStatusBulk responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicUpdateItemStatusBulkResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/v1ItemStatus' description: List of items to update status. The maximum number is 100. description: UpdateItemStatusBulk request. required: - items additionalProperties: true required: true tags: - Item /rmp/mgmt/v1/platforms/{platform_id}/report: post: summary: QueryPlatformSummary description: Read summarized reporting information of a platform. operationId: RmpManagementApi_QueryPlatformSummary responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicQueryPlatformSummaryResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform who requests management api. It is passed as a path parameter. in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: timezone: type: string description: Timezone of date_start and date_end. To be deprecated. Only platform timezone is accepted. Must be in IANA timezone name format, e.g. Asia/Seoul. date_start: type: string description: Date in 'YYYY-MM-DD' when summary begins. Inclusive. Note the allowed maximum duration for the date range is 186 days, to cover the period of any entire month. date_end: type: string description: Date in 'YYYY-MM-DD' when summary ends. Inclusive. Note the allowed maximum duration for the date range is 186 days, to cover the period of any entire month. group_by: type: array items: $ref: '#/components/schemas/v1PlatformSummaryGroupByColumn' description: A list of columns to be grouped by. Please note that among the group_by options, ITEM and CREATIVE cannot be used together. Furthermore, AD_MANAGER_ACCOUNT can be only used with CURRENCY. order_by: type: array items: $ref: '#/components/schemas/v1PlatformSummaryOrderByColumn' description: A list of columns to be ordered by. filter: type: array items: $ref: '#/components/schemas/managementv1QueryFilter' description: Query Filter. Only 1 allowed since we only support CAMPAIGN_FILTER. limit: type: string format: int64 description: Maximum number of rows to be returned. Cannot exceed 50,000 ad_account_id: type: string description: AdAccount id. description: QueryPlatformSummary request. required: - date_start - date_end additionalProperties: true required: true tags: - Report /rmp/mgmt/v1/platforms/{platform_id}/reserved-display-inventories: get: summary: ListReservedDisplayInventories description: List all eligible reserved display inventories. operationId: RmpManagementApi_ListReservedDisplayInventories responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicListReservedDisplayInventoriesResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: Identifier of the platform. It is passed as a path parameter. in: path required: true schema: type: string tags: - ReservedDisplay /rmp/mgmt/v1/platforms/{platform_id}/reserved-display-inventories/{inventory_id}/forecast: post: summary: QueryReservedInventoryForecast description: Query forecasted impressions for reserved inventory. operationId: RmpManagementApi_QueryReservedInventoryForecast responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicQueryReservedInventoryForecastResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id in: path required: true schema: type: string - name: inventory_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: dayparts: type: array items: $ref: '#/components/schemas/rmpcommonDayPart' description: Optional dayparts specifying the days and hours for forecasting. If omitted, forecast covers all hours of each day in the time interval. time_interval: $ref: '#/components/schemas/rmpcommonTimeInterval' custom_setting: $ref: '#/components/schemas/TargetingCustomSetting' required: - time_interval additionalProperties: true required: true tags: - ReservedDisplay /rmp/mgmt/v1/platforms/{platform_id}/spending-limits-bulk/read: post: summary: QuerySpendingLimits description: Query all spending limits for the platform. operationId: RmpManagementApi_QuerySpendingLimits responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicQuerySpendingLimitsResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: The Platform id. in: path required: true schema: type: string tags: - SpendingLimit /rmp/mgmt/v1/platforms/{platform_id}/wallets-bulk/read: post: summary: QueryWallets description: Query all wallets for the platform. operationId: RmpManagementApi_QueryWallets responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/publicQueryWalletsResponse' '400': description: Bad request. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '403': description: Permission denied. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '404': description: Not found. One or more required resources do not exist.You can see the details in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' '500': description: Internal server error. Detailed cause can be found in the response message. content: application/json: schema: $ref: '#/components/schemas/publicRepresentedError' parameters: - name: platform_id description: The Platform id. in: path required: true schema: type: string tags: - Wallet security: - ApiKeyAuth: [] x-readme: explorer-enabled: false servers: - url: https://-mgmt.mcm-api.moloco.com components: securitySchemes: ApiKeyAuth: type: apiKey name: x-api-key in: header Bearer: type: apiKey description: Note that the bearer authentication has been deprecated. Please refer [API and SSO Credential Management](https://mcm-docs.moloco.com/docs/api-key-and-sso-secret-generation) section to use API-key instead. name: Authorization in: header schemas: APIKeyAPIKeyType: type: string enum: - UNKNOWN_API_KEY - DECISION_API_KEY - EVENT_API_KEY - MGMT_API_KEY default: UNKNOWN_API_KEY AcceptUserJoinRequestBulkResponseAcceptUserJoinRequestResult: type: object properties: user_join_request_id: type: string description: UserJoinRequest id. is_success: type: boolean description: Flag field that indicates whether accept is succeeded or not. failed_reason: type: string description: Reason of the failure. Only filled in case of is_success is set to false. description: AcceptUserJoinRequest result required: - user_join_request_id - is_success additionalProperties: true AdAccountState: type: string enum: - UNKNOWN_STATUS - ACTIVE - INACTIVE - SUSPENDED default: UNKNOWN_STATUS AdAccountStateInfoStateCase: type: string enum: - INIT_BY_PLATFORM - ACTIVATED - OUT_OF_BUDGET - INTERNAL_ISSUE - REACHED_SPENDING_LIMIT default: INIT_BY_PLATFORM AdAccountValidationResultErrorType: type: string enum: - UNKNOWN_ERROR - ACCOUNT_NOT_FOUND - ACCOUNT_ASSIGNED default: UNKNOWN_ERROR AdAccountsNearingSpendingLimitMetricAdAccountsNearingSpendingLimitSegment: type: object properties: remaining_days_range: $ref: '#/components/schemas/rmpcommonUInt32Range' count: type: integer format: int64 description: Number of ad accounts in this remaining days range. required: - remaining_days_range additionalProperties: true AdAccountsNotAdvertisingMetricAdAccountsNotAdvertisingSegment: type: object properties: days_since_created_range: $ref: '#/components/schemas/rmpcommonUInt32Range' count: type: integer format: int64 description: Number of ad accounts in this days since created range. required: - days_since_created_range additionalProperties: true AdAccountsUnderAdvertisingItemMetricAdAccountsUnderAdvertisingItemSegment: type: object properties: item_adoption_rate_gmv_weighted_range: $ref: '#/components/schemas/rmpcommonUInt32Range' count: type: integer format: int64 description: Number of ad accounts in this item adoption rate range. required: - item_adoption_rate_gmv_weighted_range additionalProperties: true AdAccountsWalletRunningLowMetricAdAccountsWalletRunningLowSegment: type: object properties: remaining_days_range: $ref: '#/components/schemas/rmpcommonUInt32Range' count: type: integer format: int64 description: Number of ad accounts in this remaining days range. required: - remaining_days_range additionalProperties: true ApplySpendCapCampaignAssignmentChangesBFFRequestCampaignAssignmentChange: type: object properties: campaign_id: type: string description: Campaign id whose spend cap assignment is being changed. old_spend_cap_id: type: string description: Expected current Spend Cap id. If omitted, the backend validates that the campaign currently has no spend cap assignment before applying the change. new_spend_cap_id: type: string description: New Spend Cap id selected from the campaign form. If omitted, the campaign's current spend cap assignment is cleared. additionalProperties: true ApplySpendCapCampaignAssignmentChangesBFFRequestSpendCapAssignmentChange: type: object properties: spend_cap_id: type: string description: Target Spend Cap id. campaign_ids: type: array items: type: string description: Desired manually selected campaign ids. additionalProperties: true ApplySpendCapCampaignAssignmentChangesBFFResponseCampaignAssignmentChangeResult: type: object properties: campaign_id: type: string description: Campaign id whose spend cap assignment was changed. old_spend_cap_id: type: string description: Previous Spend Cap id before the assignment change. new_spend_cap_id: type: string description: New Spend Cap id after the assignment change. Omitted when the assignment was cleared. additionalProperties: true ApplySpendCapCampaignAssignmentChangesBFFResponseSpendCapAssignmentChangeResult: type: object properties: spend_cap_id: type: string description: Spend Cap id whose assignment was changed. campaign_ids: type: array items: type: string description: Manually selected campaign ids after the assignment update. additionalProperties: true AssetOptionBannerOption: type: object properties: allowed_mimes: type: array items: type: string description: Allowed content mime types for image readOnly: true max_size: type: integer format: int64 description: Maximum image file size in bytes readOnly: true use_aspect_ratio_based_validation: type: boolean description: The flag to enable aspect ratio based validation. Once it is enabled, it can't be disabled. minimum_required_size_ratio: type: number format: float description: The minimum required size ratio for the banner image. Only effective when use_aspect_ratio_based_validation is true. (0, 1] bypass_size_validation: type: boolean description: The flag to bypass the size validation check for banner image. video_option: $ref: '#/components/schemas/BannerOptionVideoOption' default_creative_attachment: $ref: '#/components/schemas/platformCreativeAttachmentDefault' description: BannerOption describes the configuration for banner resources. additionalProperties: true AssetOptionCTAOption: type: object properties: optionality: type: boolean description: The flag to indicate whether the call-to-action is optional. readOnly: true cta_list: type: array items: type: string description: List of allowed call to action options. readOnly: true description: CTAOption describes the configuration for CTA asset. additionalProperties: true AssetOptionCustomTextOption: type: object properties: optionality: type: boolean description: The flag to indicate whether the custom text is optional. readOnly: true max_length: type: integer format: int64 description: Maximum length of the custom text. readOnly: true display_title: type: string description: The display title of the custom text. readOnly: true default_color: type: string description: Default text color for custom text. Use a leading `#` plus 6 hex digits for RGB (e.g. `#FFFFFF`) or 8 hex digits for RGBA (e.g. `#FFFFFF00`). readOnly: true default_background_color: type: string description: Default background color for custom text. Use a leading `#` plus 6 hex digits for RGB (e.g. `#FFFFFF`) or 8 hex digits for RGBA (e.g. `#FFFFFF00`). readOnly: true description: CustomTextOption describes the configuration for custom text asset. additionalProperties: true AssetOptionHeadlineOption: type: object properties: optionality: type: boolean description: The flag to indicate whether the headline is optional. readOnly: true max_length: type: integer format: int64 description: Maximum length of the headline. readOnly: true display_title: type: string description: The display title of the headline. readOnly: true default_color: type: string description: Default text color for headlines. Use a leading `#` plus 6 hex digits for RGB (e.g. `#FFFFFF`) or 8 hex digits for RGBA (e.g. `#FFFFFF00`). readOnly: true default_background_color: type: string description: Default background color for headlines. Use a leading `#` plus 6 hex digits for RGB (e.g. `#FFFFFF`) or 8 hex digits for RGBA (e.g. `#FFFFFF00`). readOnly: true description: HeadlineOption describes the configuration for headline asset. additionalProperties: true AssetOptionLogoOption: type: object properties: optionality: type: boolean description: The flag to indicate whether the logo is optional. readOnly: true allowed_mimes: type: array items: type: string description: Allowed content mime types. readOnly: true max_size: type: integer format: int64 description: Maximum image file size in bytes. readOnly: true min_width: type: integer format: int64 description: Minimum image pixel width. readOnly: true min_height: type: integer format: int64 description: Minimum image pixel height. readOnly: true description: LogoOption describes the configuration for logo image. additionalProperties: true AssetOptionMetadataOption: type: object properties: key_configs: type: array items: $ref: '#/components/schemas/MetadataOptionMetadataKeyConfig' description: List of allowed metadata keys. readOnly: true description: MetadataOption describes the configuration for asset metadata keys. additionalProperties: true AudienceConfigAudienceTargetingCriteria: type: string enum: - UNKNOWN_CRITERIA - AD_ACCOUNT - AD_ACCOUNT_ITEM - CATEGORY - BRAND default: UNKNOWN_CRITERIA AudienceConfigAudienceTargetingEventType: type: string enum: - UNKNOWN_EVENT_TYPE - PURCHASE - ITEM_PAGE_VIEW default: UNKNOWN_EVENT_TYPE AudienceConfigEventBasedConfigV2: type: object properties: max_num_of_conditions: type: integer format: int64 description: The maximum number of conditions. readOnly: true item_selection_config: $ref: '#/components/schemas/EventBasedConfigV2ItemSelectionConfig' category_selection_config: $ref: '#/components/schemas/EventBasedConfigV2CategorySelectionConfig' brand_selection_config: $ref: '#/components/schemas/EventBasedConfigV2BrandSelectionConfig' available_event_types: type: array items: $ref: '#/components/schemas/AudienceConfigAudienceTargetingEventType' description: The available event types. readOnly: true available_criteria: type: array items: $ref: '#/components/schemas/AudienceConfigAudienceTargetingCriteria' description: The available criteria. readOnly: true additionalProperties: true AudienceConfigPredefinedConfig: type: object properties: max_num_of_predefined_audiences: type: integer format: int64 description: The maximum number of predefined audiences. readOnly: true additionalProperties: true AudienceSettingEventBasedList: type: object properties: conditions: type: array items: $ref: '#/components/schemas/AudienceSettingEventBasedListCondition' description: Event based audience targeting conditions. operator: $ref: '#/components/schemas/AudienceSettingEventBasedListOperator' description: EventBasedList describes event based audience targeting settings for the campaign required: - conditions - operator additionalProperties: true AudienceSettingEventBasedListCondition: type: object properties: event_type: $ref: '#/components/schemas/AudienceConfigAudienceTargetingEventType' criteria: $ref: '#/components/schemas/AudienceConfigAudienceTargetingCriteria' period_hours: type: integer format: int64 description: Event period for targeting audience in hours. selections: type: array items: type: string description: Selections of the target audience. It is required if the criteria is AD_ACCOUNT_ITEM, BRAND, or CATEGORY. description: Condition describes event based audience targeting condition for the campaign required: - event_type - criteria - period_hours additionalProperties: true AudienceSettingEventBasedListOperator: type: string enum: - UNKNOWN_OPERATOR - AND - OR default: UNKNOWN_OPERATOR BannerOptionVideoOption: type: object properties: allowed_mimes: type: array items: type: string description: Allowed content mime types for video readOnly: true max_size: type: integer format: int64 description: Maximum video file size in bytes readOnly: true duration_sec_range: $ref: '#/components/schemas/rmpcommonUInt32Range' description: VideoOption describes the configuration for banner's video option. additionalProperties: true CampaignCampaignItemSelection: type: object properties: type: $ref: '#/components/schemas/CampaignCampaignItemSelectionType' smart_selection_setting: $ref: '#/components/schemas/CampaignItemSelectionSmartSelectionSetting' description: Item selection config of the campaign. additionalProperties: true CampaignCampaignItemSelectionType: type: string enum: - UNKNOWN_TYPE - MANUAL_SELECTION - SMART_SELECTION default: UNKNOWN_TYPE description: Type of item selection for campaign. Choose MANUAL_SELECTION to select items manually or SMART_SELECTION to let Moloco choose items automatically. CampaignCampaignState: type: string enum: - PAUSED - ENDED - SCHEDULED - ACTIVE - INACTIVE - ERROR - IN_REVIEW - REJECTED - ARCHIVED default: PAUSED title: campaign’s state. Please refer to campaign states section in guides for more detailed information. (https://rmp-docs.moloco.com/docs/about-campaign-statuses) CampaignGoalMaximizeSales: type: object description: Detailed configuration of MAXIMIZE_SALES goal. additionalProperties: true CampaignGoalOptimizeFixedCommissionRate: type: object properties: commission_rate: type: number format: double description: Target commission rate percentage, rounded off to one decimal point. description: Detailed configuration of FIXED_COMMISSION_RATE goal. required: - commission_rate additionalProperties: true CampaignGoalOptimizeFixedCpm: type: object properties: target_cpm: $ref: '#/components/schemas/rmpcommonMoneyMicro' description: Detailed configuration of FIXED_CPM goal. required: - target_cpm additionalProperties: true CampaignItemSelectionSmartSelectionSetting: type: object properties: include: $ref: '#/components/schemas/SmartSelectionSettingInclude' exclude: $ref: '#/components/schemas/SmartSelectionSettingExclude' description: Configuration for Smart Selection filtering (e.g. brands, categories, on-sale, exclusions list). additionalProperties: true CampaignLandingPageCampaignLandingPageType: type: string enum: - UNKNOWN_LANDING_PAGE_TYPE - CUSTOM_URL - PRODUCT_DETAIL - PRODUCT_LIST - NONE default: UNKNOWN_LANDING_PAGE_TYPE CampaignLandingPageCustomUrlSetting: type: object properties: url: type: string description: The url of the landing page. description: Detailed configuration of a custom url landing page. required: - url additionalProperties: true CampaignLandingPageProductListSetting: type: object description: Detailed configuration of the product list page. additionalProperties: true CampaignRecommendationCampaignRecommendationStatus: type: string enum: - UNKNOWN_CAMPAIGN_RECOMMENDATION_STATUS - CAMPAIGN_RECOMMENDATION_STATUS_ACTIVE - CAMPAIGN_RECOMMENDATION_STATUS_ACCEPTED - CAMPAIGN_RECOMMENDATION_STATUS_DISMISSED - CAMPAIGN_RECOMMENDATION_STATUS_EXPIRED default: UNKNOWN_CAMPAIGN_RECOMMENDATION_STATUS CampaignRecommendationCampaignRecommendationTriggerType: type: string enum: - UNKNOWN_CAMPAIGN_RECOMMENDATION_TRIGGER_TYPE - CAMPAIGN_RECOMMENDATION_TRIGGER_TYPE_NEW_USER - CAMPAIGN_RECOMMENDATION_TRIGGER_TYPE_DORMANT_USER - CAMPAIGN_RECOMMENDATION_TRIGGER_TYPE_CHURNED_USER default: UNKNOWN_CAMPAIGN_RECOMMENDATION_TRIGGER_TYPE CampaignRecommendationCampaignRecommendationType: type: string enum: - UNKNOWN_CAMPAIGN_RECOMMENDATION_TYPE - CAMPAIGN_RECOMMENDATION_TYPE_NEW_ITEM - CAMPAIGN_RECOMMENDATION_TYPE_HIGH_POTENTIAL - CAMPAIGN_RECOMMENDATION_TYPE_SMART_SELECTION - CAMPAIGN_RECOMMENDATION_TYPE_INTELLIGENT - CAMPAIGN_RECOMMENDATION_TYPE_TOTAL_REACH default: UNKNOWN_CAMPAIGN_RECOMMENDATION_TYPE description: Recommendation campaign type produced by the recommendation engine. CampaignsExpiringSoonMetricCampaignsExpiringSoonSegment: type: object properties: remaining_days_range: $ref: '#/components/schemas/rmpcommonUInt32Range' count: type: integer format: int64 description: Number of campaigns in this remaining days range. required: - remaining_days_range additionalProperties: true CatalogConfigFeedConfig: type: object properties: enable_run_catalog_feed: type: boolean description: Whether triggering the RunCatalogFeed API is allowed for this platform. readOnly: true description: FeedConfig describes the catalog feed configurations. additionalProperties: true CatalogDagHistoryCatalogUpdateType: type: string enum: - UNKNOWN_CATALOG_UPDATE_TYPE - REFRESH - UPDATE default: UNKNOWN_CATALOG_UPDATE_TYPE CatalogHistoryValidationMetrics: type: object properties: total_processed_count: type: integer format: int64 description: Total number of items processed. error_count: type: integer format: int64 description: Number of errors encountered. additionalProperties: true CptSummaryRowSchedule: type: object properties: start: type: string end: type: string additionalProperties: true CreateAdManagerAccountRequestAdManagerAccountInfoManagingType: type: string enum: - UNKNOWN_MANAGING_TYPE - OWNER default: UNKNOWN_MANAGING_TYPE CreateImageAssetRequestImageUpload: type: object properties: file_bytes: type: string format: byte description: File bytes of the image. file_name: type: string description: File name of the image file. e.g. image.png mime_type: type: string description: Mime type of the image file. e.g. image/png description: ImageAsset creation by uploading the image payload. required: - file_bytes - mime_type - file_name additionalProperties: true CreateImageAssetRequestImageUrl: type: object properties: url: type: string description: Image url. file_name: type: string description: File name of the image file. e.g. image.png description: ImageAsset creation using the image url. required: - url - file_name additionalProperties: true CreateTokenRequestAuthType: type: string enum: - UNKNOWN_AUTH_TYPE - CREDENTIAL - TOKEN default: UNKNOWN_AUTH_TYPE description: "AuthType enumerates all authentication types of request.\n\n - CREDENTIAL: Authentication type that requires\ \ user credential. Corresponding to CredentialTypePayload.\n - TOKEN: Authentication type that requires valid token.\ \ Corresponding to TokenTypePayload." CreateTokenRequestCredentialTypePayload: type: object properties: email: type: string description: The email address of the user. password: type: string description: The password of the user. description: Request payload of CREDENTIAL authentication type. required: - email - password additionalProperties: true CreateTokenRequestTokenTypePayload: type: object properties: token: type: string description: Previously issued auth token. It should be valid to issue another one. description: Request payload of TOKEN authentication type. required: - token additionalProperties: true CreateUserJoinRequestRequestUserJoinRequestParams: type: object properties: user_email: type: string description: The requester’s user email. It will be used as an identifier. user_name: type: string description: The requester’s user name. If this field is not set, a parsed email will be used. role: $ref: '#/components/schemas/v1RoleName' description: Definition of a UserJoinRequest. required: - user_email additionalProperties: true CreateVideoAssetRequestVideoUrl: type: object properties: url: type: string additionalProperties: true DenyUserJoinRequestBulkResponseDenyUserJoinRequestResult: type: object properties: user_join_request_id: type: string description: UserJoinRequest id. is_success: type: boolean description: Flag field that indicates whether deny is succeeded or not. failed_reason: type: string description: Reason of the failure. Only filled in case of is_success is set to false. description: DenyUserJoinRequest result required: - user_join_request_id - is_success additionalProperties: true EntityChangeLogEntityChangeMethod: type: string enum: - UNKNOWN_ENTITY_CHANGE_METHOD - CREATE - UPDATE - DELETE default: UNKNOWN_ENTITY_CHANGE_METHOD EntityChangeLogFieldType: type: string enum: - UNKNOWN_Field_TYPE - STRING - ARRAY - OBJECT default: UNKNOWN_Field_TYPE EventBasedConfigV2BrandSelectionConfig: type: object properties: max_num_of_brands: type: integer format: int64 description: The maximum number of brands can be selected in a condition. readOnly: true use_brand_id: type: boolean description: The flag to indicate whether the brand id is used or not. readOnly: true description: BrandSelectionConfig contains the configuration for brand selection. additionalProperties: true EventBasedConfigV2CategorySelectionConfig: type: object properties: max_num_of_categories: type: integer format: int64 description: The maximum number of categories can be selected in a condition. readOnly: true max_depth_of_categories: type: integer format: int64 description: The maximum depth of categories. readOnly: true description: CategorySelectionConfig contains the configuration for category selection. additionalProperties: true EventBasedConfigV2ItemSelectionConfig: type: object properties: max_num_of_items: type: integer format: int64 description: The maximum number of items can be selected in a condition. readOnly: true description: ItemSelectionConfig contains the configuration for item selection. additionalProperties: true ForecastCampaignParamsCampaignGoalCampaignGoalType: type: string enum: - FIXED_CPC - OPTIMIZE_ROAS default: UNKNOWN_TYPE description: This message follows same field number with CampaignGoalType. FrequencyCappingResetPeriod: type: string enum: - UNKNOWN_RESET_PERIOD - HOUR - DAY - WEEK - MONTH - LIFETIME default: UNKNOWN_RESET_PERIOD GetCatalogFeedSyncOverviewBFFResponseSyncHealth: type: string enum: - UNKNOWN_SYNC_HEALTH - HEALTHY - RUNNING - FAILING - STALE - OVERDUE - NEVER_RUN default: UNKNOWN_SYNC_HEALTH GetOffsiteAdAccountBudgetResponseOffsiteAccountBudget: type: object properties: unlimited: type: boolean description: True when the Google account budget has no numeric cap (unlimited spending). total_budget is unset in that case. total_budget: $ref: '#/components/schemas/rmpcommonMoneyMicro' spent: $ref: '#/components/schemas/rmpcommonMoneyMicro' last_updated: type: string format: date-time description: Server time the budget was read from Google. This is a live read; Google exposes no reliable budget-modification time, so this is the fetch time. description: 'OffsiteAccountBudget is the Google account-level budget for the offsite ad-account page''s budget card (B06): the approved spending cap (or an unlimited flag) and the amount served against it. Read live from Google Ads per request. This is the Google account budget, NOT the Moloco onsite wallet and NOT the reporting serving table''s performance spend. Nested here as it is only ever returned by this RPC.' additionalProperties: true GooglePMaxGoalSettingMaximizeConversionValue: type: object properties: target_roas_percent: type: integer format: int64 description: 'Optional target ROAS percent (e.g. 150 = 1.5x). 0 means no target ROAS is applied; PMax will optimize for conversion value without a ROAS constraint.' additionalProperties: true GuidanceConfigCPPConfig: type: object properties: guided_range: $ref: '#/components/schemas/rmpcommonFloatingPointRange' static_guided_cpp: type: number format: double description: Guided CPP value for new campaigns in percentage. readOnly: true description: CPP guidance configurations for the platform. required: - guided_range - static_guided_cpp additionalProperties: true GuidedMessageGuidedMessageType: type: string enum: - UNKNOWN - NO_GUIDED_MESSAGE - ADD_MORE_SUGGESTED_ITEMS - RECOMMEND_BID - RECOMMEND_BUDGET - RECOMMEND_ROAS - NO_GUIDED_MESSAGE_IN_COOLDOWN - NO_GUIDED_MESSAGE_INSUFFICIENT_DATA default: UNKNOWN IdentifyLoginMethodResponseLoginMethod: type: string enum: - LOGIN_METHOD_UNSPECIFIED - PASSWORD - SAML_SSO default: LOGIN_METHOD_UNSPECIFIED InventoryInventoryPlacementType: type: string enum: - UNKNOWN_INVENTORY_PLACEMENT_TYPE - DEFAULT - HOME - CATEGORY - SEARCH - PRODUCT_DETAIL - CART - CHECKOUT - RANKING - OTHERS default: UNKNOWN_INVENTORY_PLACEMENT_TYPE description: InventoryPlacementType represents the placement functionality for the inventory. ItemBasedGuidanceConfigSponsoredBrandConfigBudgetConfig: type: object properties: budget_range: $ref: '#/components/schemas/rmpcommonMicroRange' gmv_for_budget_guidance: type: number format: double description: Percentage of GMV guided as budget for sponsored brand campaigns. readOnly: true description: Budget configuration for item-based guidance. additionalProperties: true ItemBasedGuidanceConfigSponsoredBrandConfigFixedCPCConfig: type: object properties: bid_range: $ref: '#/components/schemas/rmpcommonMicroRange' description: Fixed CPC configuration for item-based guidance. additionalProperties: true ItemBasedGuidanceConfigSponsoredProductConfig: type: object properties: fixed_cpc_config: $ref: '#/components/schemas/ItemBasedGuidanceConfigSponsoredProductConfigFixedCPCConfig' fixed_cpm_config: $ref: '#/components/schemas/SponsoredProductConfigFixedCPMConfig' optimized_roas_config: $ref: '#/components/schemas/SponsoredProductConfigOptimizedROASConfig' budget_config: $ref: '#/components/schemas/ItemBasedGuidanceConfigSponsoredProductConfigBudgetConfig' maximize_sales_config: $ref: '#/components/schemas/SponsoredProductConfigMaximizeSalesConfig' description: Item-based guidance configuration for sponsored product campaigns. additionalProperties: true ItemBasedGuidanceConfigSponsoredProductConfigBudgetConfig: type: object properties: budget_range: $ref: '#/components/schemas/rmpcommonMicroRange' gmv_cap: type: number format: double description: Maximum percentage of GMV used as the upper bound of the guided budget. readOnly: true description: Budget configuration for item-based guidance. additionalProperties: true ItemBasedGuidanceConfigSponsoredProductConfigFixedCPCConfig: type: object properties: bid_range: $ref: '#/components/schemas/rmpcommonMicroRange' target_purchase_for_new_campaign: type: integer format: int32 description: Target purchase count used for new campaign guidance interpolation. readOnly: true description: Fixed CPC configuration for item-based guidance. additionalProperties: true KeywordConfigNegativeKeywordConfig: type: object properties: enabled: type: boolean description: Flag to enable the negative keyword targeting from campaign. readOnly: true max_keywords_per_campaign: type: integer format: int64 description: Max number of keywords in single campaign. readOnly: true description: NegativeKeywordConfig contains the configuration related to the Negative Keyword Targeting. required: - enabled - max_keywords_per_campaign additionalProperties: true KeywordConfigPositiveKeywordConfig: type: object properties: enabled: type: boolean description: Flag to enable the keyword targeting from campaign. readOnly: true max_keywords_per_campaign: type: integer format: int64 description: Max number of keywords in single campaign. readOnly: true enabled_broad_keyword_targeting: type: boolean description: Flag to enable broad match keyword targeting from campaign. This will replace the `BROAD_KEYWORD_TARGETING` available feature in future. Before the replacement, this flag will follow the available feature flag for broad match keyword targeting. readOnly: true description: PositiveKeywordConfig contains the configuration related to the (Positive) Keyword Targeting. required: - enabled - max_keywords_per_campaign additionalProperties: true KeywordSettingNegativeKeyword: type: object properties: value: type: string description: NegativeKeyword describes target negative keyword targeting settings for the campaign required: - value additionalProperties: true KeywordSettingPositiveKeyword: type: object properties: value: type: string match_type: $ref: '#/components/schemas/commonCampaignKeywordMatchType' cost_price: $ref: '#/components/schemas/rmpcommonMoneyMicro' description: PositiveKeyword describes target positive keyword targeting settings for the campaign required: - value - match_type additionalProperties: true LabelAssignmentType: type: string enum: - UNKNOWN_ASSIGNMENT_TYPE - SINGLE - MULTIPLE default: UNKNOWN_ASSIGNMENT_TYPE LabelValueWithEntitySummaryEntitySummary: type: object properties: entity_type: $ref: '#/components/schemas/commonLabelValueEntityType' num_of_associated_entities: type: string format: int64 description: Total number of associated entities for this entity type. sampled_entity_ids: type: array items: type: string description: The IDs of entities associated with this value. The number of IDs can be less than num_of_associated_entities due to the response size limit. additionalProperties: true LandingOptionCustomUrlOption: type: object properties: max_length: type: integer format: int64 description: Maximum length of the landing URL. readOnly: true description: CustomUrlOption describes the configuration for custom input landing URL. additionalProperties: true LandingOptionProductDetailOption: type: object description: ProductDetailOption describes the configuration for PDP page landing URL. additionalProperties: true LandingOptionProductListOption: type: object properties: max_items: type: integer format: int64 description: Maximum number of items. readOnly: true description: ProductLiseOption describes the configuration for product listing page landing URL. additionalProperties: true LandingUrlReviewStatusLandingUrlStatus: type: string enum: - UNKNOWN_LANDING_URL_STATUS - IN_REVIEW - APPROVED - REJECTED default: UNKNOWN_LANDING_URL_STATUS title: enum type for landing url's status LineItemGoalReservedImpressions: type: object properties: target_cpm: $ref: '#/components/schemas/rmpcommonMoneyMicro' target_impressions: type: integer format: int64 description: The reserved impressions amount. additionalProperties: true LineItemGoalReservedTime: type: object properties: cost: $ref: '#/components/schemas/rmpcommonMoneyMicro' description: Goal setting for a RESERVED_TIME (CPT) line item. The line item owns 100% of the targeted inventory for the fixed schedule window. required: - cost additionalProperties: true ListCampaignReviewsRequestBrandEntityTypeQueryOption: type: string enum: - ALL - ASSET - LANDING_PAGE default: ALL ListExperimentalFeaturesResponseExperimentalFeature: type: string enum: - EXPERIMENTAL_FEATURE_UNSPECIFIED - EXPERIMENTAL_FEATURE_CREATIVE_AGENT - EXPERIMENTAL_FEATURE_CREATIVE_AGENT_2 default: EXPERIMENTAL_FEATURE_UNSPECIFIED ListLineItemDailyReportRequestDateSortOption: type: string enum: - DATE_ASC - DATE_DESC default: DATE_ASC ListManagedDashboardOverviewsResponseManagedDashboardResource: type: object properties: campaign: $ref: '#/components/schemas/v1Campaign' ad_account: $ref: '#/components/schemas/ListManagedDashboardOverviewsResponseManagedDashboardResourceAdAccount' items: type: array items: $ref: '#/components/schemas/ManagedDashboardResourceItem' creatives: type: array items: $ref: '#/components/schemas/v1Creative' title: creative related information report: $ref: '#/components/schemas/ListManagedDashboardOverviewsResponseManagedDashboardResourceReport' required: - campaign - ad_account - report additionalProperties: true ListManagedDashboardOverviewsResponseManagedDashboardResourceAdAccount: type: object properties: id: type: string title: type: string title: ad account related information additionalProperties: true ListManagedDashboardOverviewsResponseManagedDashboardResourceReport: type: object properties: imp_count: type: string format: int64 click_count: type: string format: int64 title: report related information additionalProperties: true ListReservedDisplayInventoriesResponseReservedDisplayInventory: type: object properties: id: type: string description: Identifier of the inventory. title: type: string description: Title of the inventory. additionalProperties: true ListSpendCapDetailOverviewRequestLegacyQueryFilter: type: object properties: filters: type: array items: $ref: '#/components/schemas/ListSpendCapDetailOverviewRequestLegacyQueryFilterSingleFilter' logical_operator: $ref: '#/components/schemas/ListSpendCapDetailOverviewRequestLegacyQueryFilterLogicalOperator' additionalProperties: true ListSpendCapDetailOverviewRequestLegacyQueryFilterLogicalOperator: type: string enum: - OR default: OR ListSpendCapDetailOverviewRequestLegacyQueryFilterSingleFilter: type: object properties: column: $ref: '#/components/schemas/ListSpendCapDetailOverviewRequestLegacyQueryFilterSingleFilterFilterColumn' filter_operator: $ref: '#/components/schemas/ListSpendCapDetailOverviewRequestLegacyQueryFilterSingleFilterFilterOperator' value: $ref: '#/components/schemas/ListSpendCapDetailOverviewRequestLegacyQueryFilterSingleFilterFilterValue' additionalProperties: true ListSpendCapDetailOverviewRequestLegacyQueryFilterSingleFilterFilterColumn: type: string enum: - UNKNOWN_FILTER_COLUMN - STATUS default: UNKNOWN_FILTER_COLUMN ListSpendCapDetailOverviewRequestLegacyQueryFilterSingleFilterFilterOperator: type: string enum: - UNKNOWN_FILTER_OPERATOR - EQ default: UNKNOWN_FILTER_OPERATOR ListSpendCapDetailOverviewRequestLegacyQueryFilterSingleFilterFilterValue: type: string enum: - UNKNOWN_FILTER_VALUE - SCHEDULED - INACTIVE - ACTIVE - ENDED - DEPLETED - ERROR default: UNKNOWN_FILTER_VALUE description: " - SCHEDULED: Similar to the Scheduled state of a campaign, the SpendCap is in a “reserved” state because\ \ its period has not yet started.\n - INACTIVE: The status when the user manually changes the SpendCap from Active\ \ to Inactive.\n - ACTIVE: The SpendCap is in an Active state. As long as the amount is not depleted, the mapped campaigns\ \ can remain Active and serve ads without issues\n - ENDED: One of the cases where the SpendCap is no longer Active\ \ because its defined period has ended.\n - DEPLETED: The SpendCap has reached its allocated amount (0 remaining).\ \ As a result, the mapped campaigns can no longer remain active and ad serving stops, even though the period itself\ \ has not yet ended.\n - ERROR: Error state. The campaign state does not belong to any states above." ListSpendCapDetailOverviewResponseSpendCapDetailOverview: type: object properties: spend_cap_id: type: string description: The id of the SpendCap. spend_cap_title: type: string description: A descriptive name of the SpendCap. status: $ref: '#/components/schemas/v1SpendCapSpendCapStatus' remaining_amount: type: string format: int64 description: Remaining amount of the spend cap. total_amount: type: string format: int64 description: Budget of the spend cap. currency: type: string description: Currency of the spend cap. period: $ref: '#/components/schemas/v1SpendCapPeriod' usage: type: number format: double description: Usage of the spend cap budget. Spent Amount / Total Amount in percentage. schedule: $ref: '#/components/schemas/rmpcommonTimeInterval' additionalProperties: true ListSpendCapsRequestFilter: type: object properties: status: $ref: '#/components/schemas/v1SpendCapSpendCapStatus' additionalProperties: true ListVideoAssetsRequestVideoStatusQueryOption: type: string enum: - ALL - PENDING - READY default: ALL MFAConfigPolicy: type: string enum: - UNKNOWN_POLICY - MFA_DISABLED - MFA_OPTIONAL - MFA_REQUIRED default: UNKNOWN_POLICY ManagedConfigCreativeConfig: type: object properties: max_num_creatives: type: integer format: int64 description: Max number of creatives in the creative campaign readOnly: true image_setting: $ref: '#/components/schemas/commonplatformImageSetting' additionalProperties: true ManagedConfigProductConfig: type: object properties: max_num_items: type: integer format: int64 description: Max number of items in the product campaign readOnly: true additionalProperties: true ManagedDashboardResourceItem: type: object properties: id: type: string title: type: string additionalProperties: true MetadataOptionMetadataKeyConfig: type: object properties: key: type: string description: Metadata key. readOnly: true additionalProperties: true OffsiteCampaignEnablingState: type: string enum: - UNKNOWN_STATE - ENABLED - DISABLED default: UNKNOWN_STATE description: 'Seller-requested enabling state. This is seller intent, not a serving observation. Observed serving state lives in offsite_executions[*].serving_state and may diverge from this field.' OffsiteResourceSorterSingleSort: type: object properties: column: $ref: '#/components/schemas/OffsiteResourceSorterSortColumn' direction: $ref: '#/components/schemas/commonOrderByDirection' additionalProperties: true OffsiteResourceSorterSortColumn: type: string enum: - UNKNOWN_SORT_COLUMN - TITLE - CREATED_AT - MONEY_SPENT - IMPRESSIONS - CLICKS - PURCHASES - REVENUE - CTR - CPC - ROAS default: UNKNOWN_SORT_COLUMN description: "SortColumn is a sortable column: an entity attribute, a raw metric total, or a\nderived ratio — the metric/ratio\ \ columns aggregate over the request's date\nrange. Nested inside the message so the values need no enum-name prefix.\n\ \n - TITLE: Entity columns.\n - MONEY_SPENT: Raw metric totals over the date range.\n - CTR: Derived ratios over the\ \ date range." OrderOrderState: type: string enum: - SCHEDULED - PAUSED - ACTIVE - ENDED - DRAFT default: SCHEDULED description: order's state. OverwritePredefinedAudienceAdAccountAccessBulkRequestUpdateAccess: type: string enum: - UNKNOWN - ACCESSIBLE default: UNKNOWN PacingPacingType: type: string enum: - UNKNOWN - ASAP - EVEN - ACCELERATED default: UNKNOWN PlacementConfigCartConfig: type: object properties: enabled: type: boolean description: Flag to enable the placement for CART PlacementType from campaign. readOnly: true description: CartConfig contains the configuration related to the Cart PlacementType. required: - enabled additionalProperties: true PlacementConfigCategoryConfig: type: object properties: enabled: type: boolean description: Flag to enable the placement for CATEGORY PlacementType from campaign. readOnly: true description: CategoryConfig contains the configuration related to the Category PlacementType. required: - enabled additionalProperties: true PlacementConfigCheckoutConfig: type: object properties: enabled: type: boolean description: Flag to enable the placement for CHECKOUT PlacementType from campaign. readOnly: true description: CheckoutConfig contains the configuration related to the Checkout PlacementType. required: - enabled additionalProperties: true PlacementConfigHomeConfig: type: object properties: enabled: type: boolean description: Flag to enable the placement for HOME PlacementType from campaign. readOnly: true description: HomeConfig contains the configuration related to the Home PlacementType. required: - enabled additionalProperties: true PlacementConfigProductDetailConfig: type: object properties: enabled: type: boolean description: Flag to enable the placement for PRODUCT_DETAIL PlacementType from campaign. readOnly: true description: ProductDetailConfig contains the configuration related to the ProductDetail PlacementType. required: - enabled additionalProperties: true PlacementConfigSearchConfig: type: object properties: enabled: type: boolean description: Flag to enable the placement for SEARCH PlacementType from campaign. readOnly: true keyword_config: $ref: '#/components/schemas/SearchConfigKeywordConfig' description: SearchConfig contains the configuration related to the Search PlacementType. required: - enabled additionalProperties: true PlacementSettingCartSetting: type: object properties: enabled: type: boolean description: If set true, the campaign will target Cart Placement. cost_price: $ref: '#/components/schemas/rmpcommonMoneyMicro' description: Targeting setting of the Cart Placement. required: - enabled additionalProperties: true PlacementSettingCategorySetting: type: object properties: enabled: type: boolean description: If set true, the campaign will target the Category Placement. cost_price: $ref: '#/components/schemas/rmpcommonMoneyMicro' description: Targeting setting of the Category Placement. required: - enabled additionalProperties: true PlacementSettingCheckoutSetting: type: object properties: enabled: type: boolean description: If set true, the campaign will target the Checkout Placement. cost_price: $ref: '#/components/schemas/rmpcommonMoneyMicro' description: Targeting setting of the Checkout Placement. required: - enabled additionalProperties: true PlacementSettingHomeSetting: type: object properties: enabled: type: boolean description: If set true, the campaign will target the Home Placement. cost_price: $ref: '#/components/schemas/rmpcommonMoneyMicro' description: Targeting setting of the Home Placement. required: - enabled additionalProperties: true PlacementSettingRankingSetting: type: object properties: enabled: type: boolean description: If set true, the campaign will target the Ranking Placement. cost_price: $ref: '#/components/schemas/rmpcommonMoneyMicro' description: Targeting setting of the Ranking Placement. required: - enabled additionalProperties: true PlacementSettingSearchSetting: type: object properties: enabled: type: boolean description: If set true, the campaign will target the Search Placement. cost_price: $ref: '#/components/schemas/rmpcommonMoneyMicro' keyword_setting: $ref: '#/components/schemas/SearchSettingKeywordSetting' description: Targeting setting of the Search Placement. required: - enabled additionalProperties: true PlatformDashboardResourceAdAccountAdoptionRate: type: object properties: date: type: string adoption_rate: type: number format: double adoption_rate_gmv_weighted: type: number format: double description: AdAccountAdoptionRate. additionalProperties: true PlatformDashboardResourceAdSpendByGMVPercent: type: object properties: date: type: string ad_spend_by_gmv_perc: type: number format: double description: AdSpendByGMVPercent. additionalProperties: true PlatformDashboardResourceAggrSummaryBySubMetric: type: object properties: money_spent_micro: $ref: '#/components/schemas/PlatformDashboardResourceMetricSummaryInt' imp_count: $ref: '#/components/schemas/PlatformDashboardResourceMetricSummaryInt' click_count: $ref: '#/components/schemas/PlatformDashboardResourceMetricSummaryInt' direct_purchase_count: $ref: '#/components/schemas/PlatformDashboardResourceMetricSummaryInt' indirect_purchase_count: $ref: '#/components/schemas/PlatformDashboardResourceMetricSummaryInt' total_purchase_count: $ref: '#/components/schemas/PlatformDashboardResourceMetricSummaryInt' direct_revenue_micro: $ref: '#/components/schemas/PlatformDashboardResourceMetricSummaryInt' indirect_revenue_micro: $ref: '#/components/schemas/PlatformDashboardResourceMetricSummaryInt' total_revenue_micro: $ref: '#/components/schemas/PlatformDashboardResourceMetricSummaryInt' ctr: $ref: '#/components/schemas/PlatformDashboardResourceMetricSummaryDouble' cpc: $ref: '#/components/schemas/PlatformDashboardResourceMetricSummaryDouble' direct_roas: $ref: '#/components/schemas/PlatformDashboardResourceMetricSummaryDouble' indirect_roas: $ref: '#/components/schemas/PlatformDashboardResourceMetricSummaryDouble' total_roas: $ref: '#/components/schemas/PlatformDashboardResourceMetricSummaryDouble' direct_cr: $ref: '#/components/schemas/PlatformDashboardResourceMetricSummaryDouble' indirect_cr: $ref: '#/components/schemas/PlatformDashboardResourceMetricSummaryDouble' total_cr: $ref: '#/components/schemas/PlatformDashboardResourceMetricSummaryDouble' description: AggrSummary By Sub-Metric. additionalProperties: true PlatformDashboardResourceAggregationSummary: type: object properties: per_metric: $ref: '#/components/schemas/PlatformDashboardResourceAggrSummaryBySubMetric' by_timeseries: $ref: '#/components/schemas/PlatformDashboardResourceMetricSummaryDouble' description: 'Aggregation Summary. Can be either summary by submetric or summary by timeseries.' additionalProperties: true PlatformDashboardResourceItemAdoptionRate: type: object properties: date: type: string adoption_rate: type: number format: double adoption_rate_gmv_weighted: type: number format: double description: ItemAdoptionRate. additionalProperties: true PlatformDashboardResourceMetricData: type: object properties: ad_spend_by_gmv_percent: $ref: '#/components/schemas/PlatformDashboardResourceAdSpendByGMVPercent' metrics_for_top_spending_advertisers: $ref: '#/components/schemas/PlatformDashboardResourceMetricsForTopSpendingAdvertisers' ad_account_adoption_rate: $ref: '#/components/schemas/PlatformDashboardResourceAdAccountAdoptionRate' item_adoption_rate: $ref: '#/components/schemas/PlatformDashboardResourceItemAdoptionRate' overall_by_category: $ref: '#/components/schemas/PlatformDashboardResourceOverallByCategory' overall_by_inventory: $ref: '#/components/schemas/PlatformDashboardResourceOverallByInventory' description: 'MetricData: Oneof the metrics defined above.' additionalProperties: true PlatformDashboardResourceMetricSummaryDouble: type: object properties: value: type: number format: double comp_value: type: number format: double percent_difference: type: number format: double description: Metric summary for double values. additionalProperties: true PlatformDashboardResourceMetricSummaryInt: type: object properties: value: type: string format: int64 comp_value: type: string format: int64 percent_difference: type: number format: double description: Metric summary for int64 values. additionalProperties: true PlatformDashboardResourceMetricsForTopSpendingAdvertisers: type: object properties: ad_account_title: type: string report_metric: $ref: '#/components/schemas/PlatformDashboardResourceReportMetric' description: MetricsForTopSpendingAdvertisers. additionalProperties: true PlatformDashboardResourceOverallByCategory: type: object properties: category_title: type: string report_metric: $ref: '#/components/schemas/PlatformDashboardResourceReportMetric' description: OverallByCategory. additionalProperties: true PlatformDashboardResourceOverallByInventory: type: object properties: inventory_title: type: string report_metric: $ref: '#/components/schemas/PlatformDashboardResourceReportMetric' description: OverallByInventory. additionalProperties: true PlatformDashboardResourceReportMetric: type: object properties: money_spent_micro: type: string format: int64 imp_count: type: string format: int64 click_count: type: string format: int64 direct_purchase_count: type: string format: int64 indirect_purchase_count: type: string format: int64 total_purchase_count: type: string format: int64 direct_revenue_micro: type: string format: int64 indirect_revenue_micro: type: string format: int64 total_revenue_micro: type: string format: int64 ctr: type: number format: double cpc: type: number format: double direct_roas: type: number format: double indirect_roas: type: number format: double total_roas: type: number format: double direct_cr: type: number format: double indirect_cr: type: number format: double total_cr: type: number format: double description: Report Metric. additionalProperties: true PlatformDashboardResourceSubMetricType: type: string enum: - UNKNOWN_SUB_METRIC_TYPE - MONEY_SPENT - IMP_COUNT - CLICK_COUNT - PURCHASE_COUNT - REVENUE - CTR - CPC - ROAS - CR - ALL default: UNKNOWN_SUB_METRIC_TYPE PlatformInfoAPIConfig: type: object properties: mgmt_api_url: type: string description: Management service REST API URL (e.g. https://customer-id-mgmt.rmp-api.moloco.com). required: - mgmt_api_url additionalProperties: true PlatformInsightResourceAdAccountsNearingSpendingLimitMetric: type: object properties: total_count: type: integer format: int64 description: Total count of ad accounts nearing spending limit. ad_accounts_nearing_spending_limit_segments: type: array items: $ref: '#/components/schemas/AdAccountsNearingSpendingLimitMetricAdAccountsNearingSpendingLimitSegment' description: Segments of ad accounts grouped by remaining days range. additionalProperties: true PlatformInsightResourceAdAccountsNotAdvertisingMetric: type: object properties: total_count: type: integer format: int64 description: Total count of ad accounts not advertising. ad_accounts_not_advertising_segments: type: array items: $ref: '#/components/schemas/AdAccountsNotAdvertisingMetricAdAccountsNotAdvertisingSegment' description: Segments of ad accounts grouped by days since created. additionalProperties: true PlatformInsightResourceAdAccountsUnderAdvertisingItemMetric: type: object properties: total_count: type: integer format: int64 description: Total count of ad accounts under advertising items. ad_accounts_under_advertising_item_segments: type: array items: $ref: '#/components/schemas/AdAccountsUnderAdvertisingItemMetricAdAccountsUnderAdvertisingItemSegment' description: Segments of ad accounts grouped by item adoption rate. additionalProperties: true PlatformInsightResourceAdAccountsWalletRunningLowMetric: type: object properties: total_count: type: integer format: int64 description: Total count of ad accounts with wallet running low. ad_accounts_wallet_running_low_segments: type: array items: $ref: '#/components/schemas/AdAccountsWalletRunningLowMetricAdAccountsWalletRunningLowSegment' description: Segments of ad accounts grouped by remaining days range. additionalProperties: true PlatformInsightResourceCampaignsExpiringSoonMetric: type: object properties: total_count: type: integer format: int64 description: Total count of campaigns expiring soon. campaigns_expiring_soon_segments: type: array items: $ref: '#/components/schemas/CampaignsExpiringSoonMetricCampaignsExpiringSoonSegment' description: Segments of campaigns grouped by remaining days range. additionalProperties: true PlatformInsightResourceCampaignsHighTargetRoasMetric: type: object properties: total_count: type: integer format: int64 description: Total count of campaigns with high target ROAS. campaigns: type: array items: $ref: '#/components/schemas/PlatformInsightResourceCampaignsHighTargetRoasMetricCampaignHighTargetRoas' description: List of campaigns with high target ROAS issues. additionalProperties: true PlatformInsightResourceCampaignsHighTargetRoasMetricCampaignHighTargetRoas: type: object properties: title: type: string description: Campaign title. ad_account_title: type: string description: Ad account title. budget_utilization: type: number format: double description: Budget utilization percentage. target_roas: type: integer format: int64 description: Current target ROAS. suggested_target_roas: type: integer format: int64 description: Suggested target ROAS. additionalProperties: true PlatformInsightResourceCampaignsLowBidMetric: type: object properties: total_count: type: integer format: int64 description: Total count of campaigns with low bid. campaigns: type: array items: $ref: '#/components/schemas/PlatformInsightResourceCampaignsLowBidMetricCampaignLowBid' description: List of campaigns with low bid issues. additionalProperties: true PlatformInsightResourceCampaignsLowBidMetricCampaignLowBid: type: object properties: title: type: string description: Campaign title. ad_account_title: type: string description: Ad account title. budget_utilization: type: number format: double description: Budget utilization percentage. target_cpc: $ref: '#/components/schemas/rmpcommonMoneyMicro' target_cpm: $ref: '#/components/schemas/rmpcommonMoneyMicro' suggested_bid: $ref: '#/components/schemas/rmpcommonMoneyMicro' required: - suggested_bid additionalProperties: true PlatformInsightResourceCampaignsLowBudgetMetric: type: object properties: total_count: type: integer format: int64 description: Total count of campaigns with low budget. campaigns: type: array items: $ref: '#/components/schemas/PlatformInsightResourceCampaignsLowBudgetMetricCampaignLowBudget' description: List of campaigns with low budget issues. additionalProperties: true PlatformInsightResourceCampaignsLowBudgetMetricCampaignLowBudget: type: object properties: title: type: string description: Campaign title. missed_impression_count: type: string format: uint64 description: Number of missed impressions due to low budget. additionalProperties: true PlatformInsightResourceTopSellersNotOnboardedMetric: type: object properties: not_advertising_top_seller_percentage: type: number format: double description: Percentage of top sellers not advertising. gmv: $ref: '#/components/schemas/rmpcommonMoneyMicro' top_sellers_segments: type: array items: $ref: '#/components/schemas/TopSellersNotOnboardedMetricTopSellersSegment' description: Segments of top sellers grouped by onboarding status. required: - gmv additionalProperties: true PlatformOwnerConfigAPIKey: type: object properties: type: $ref: '#/components/schemas/APIKeyAPIKeyType' name: type: string description: Name for the APIKey. Length limited to 128. expiration_timestamp: type: string format: date-time description: Expiration timestamp for the key. description: APIKey contains api key information for an RMP service to access the Platform. required: - type - name additionalProperties: true PlatformOwnerConfigInventoryType: type: string enum: - UNKNOWN_INVENTORY_TYPE - ONSITE - OFFSITE default: UNKNOWN_INVENTORY_TYPE PredefinedAudienceConfigDataSource: type: string enum: - UNKNOWN_DATA_SOURCE - FEED - CDP default: UNKNOWN_DATA_SOURCE PredefinedAudienceConfigSyncStatus: type: object properties: healthy_days_threshold: type: integer format: int64 description: The healthy days threshold of the sync status. readOnly: true description: SyncStatus is the configuration of the predefined audience. additionalProperties: true QueryAdAccountsAdvertisingPlatformInsightDetailsResponseAdAccountNotAdvertising: type: object properties: id: type: string description: Unique identifier of the ad account. title: type: string description: Title of the ad account. gmv: $ref: '#/components/schemas/rmpcommonMoneyMicro' created_at: type: string format: date-time description: Creation date and time of the ad account. wallet_balance: $ref: '#/components/schemas/rmpcommonMoneyMicro' required: - gmv - created_at additionalProperties: true QueryAdAccountsItemAdoptionPlatformInsightDetailsResponseAdAccountUnderAdvertisingItem: type: object properties: id: type: string description: Unique identifier of the ad account. title: type: string description: Title of the ad account. adoption_rate_gmv_weighted: type: number format: double description: GMV-weighted item adoption rate for the ad account. budget: $ref: '#/components/schemas/rmpcommonBudget' budget_utilization: type: number format: double description: Budget utilization percentage for the campaign. required: - budget additionalProperties: true QueryAdAccountsSpendingLimitPlatformInsightDetailsResponseNearingSpendingLimitAdAccount: type: object properties: id: type: string description: Unique identifier of the ad account. title: type: string description: Title of the ad account. spending_limit: $ref: '#/components/schemas/rmpcommonMoneyMicro' spending_limit_gap: $ref: '#/components/schemas/rmpcommonMoneyMicro' active_campaign_count: type: integer format: int64 description: Number of active campaigns for the ad account. ad_spend: $ref: '#/components/schemas/rmpcommonMoneyMicro' budget: $ref: '#/components/schemas/rmpcommonBudget' required: - spending_limit - spending_limit_gap - ad_spend - budget additionalProperties: true QueryAdAccountsWalletPlatformInsightDetailsResponseWalletRunningLowAdAccount: type: object properties: id: type: string description: Unique identifier of the ad account. title: type: string description: Display name of the ad account. wallet_balance: $ref: '#/components/schemas/rmpcommonMoneyMicro' remaining_days: type: integer format: int64 description: Number of days remaining before wallet balance runs out based on current spending rate. active_campaign_count: type: integer format: int64 description: Number of active campaigns in the ad account. ad_spend: $ref: '#/components/schemas/rmpcommonMoneyMicro' budget: $ref: '#/components/schemas/rmpcommonBudget' required: - wallet_balance - ad_spend - budget additionalProperties: true QueryCampaignHomeResourcesRequestMediaTypeQueryFilter: type: string enum: - ALL - IMAGE - VIDEO default: ALL QueryCampaignsExpirationPlatformInsightDetailsResponseCampaignExpiringSoon: type: object properties: id: type: string description: Unique identifier of the campaign. title: type: string description: Title of the campaign. ad_account_id: type: string description: Unique identifier of the ad account. ad_account_title: type: string description: Title of the ad account. end: type: string format: date-time description: Campaign end date and time. ad_spend: $ref: '#/components/schemas/rmpcommonMoneyMicro' budget: $ref: '#/components/schemas/rmpcommonBudget' required: - end - ad_spend - budget additionalProperties: true QueryInventoriesWithAccessSummaryResponseInventoryWithAccessSummary: type: object properties: inventory: $ref: '#/components/schemas/managementv1Inventory' visibility: $ref: '#/components/schemas/v1EntityVisibilityType' accessible_ad_account_size: type: integer format: int64 title: Number of ad accounts that has direct access to it accessible_label_value_size: type: integer format: int64 title: Number of label values that has access to it sampled_label_value_names: type: array items: type: string description: Sampled label value names that has direct access to this inventory. The number of sampled label values is up to 2. required: - inventory - visibility - accessible_ad_account_size - accessible_label_value_size - sampled_label_value_names additionalProperties: true QueryInventoryMonitoringRequestGranularity: type: string enum: - UNKNOWN - TEN_MINUTES - ONE_HOUR - ONE_DAY default: UNKNOWN QueryLabelValuesWithEntitySummaryResponseLabelValueWithEntitySummary: type: object properties: label_value: $ref: '#/components/schemas/v1LabelValue' entity_summaries: type: array items: $ref: '#/components/schemas/LabelValueWithEntitySummaryEntitySummary' description: Summary of entities associated for the given label value. label_name: type: string description: The name of the label. additionalProperties: true QueryPlatformDashboardResourcesRequestMetric: type: object properties: metric_type: $ref: '#/components/schemas/v1PlatformDashboardResourceMetricType' submetric_type: $ref: '#/components/schemas/PlatformDashboardResourceSubMetricType' required: - metric_type additionalProperties: true QueryPredefinedAudiencesWithAccessSummaryRequestActiveFilter: type: string enum: - UNKNOWN_ACTIVE_FILTER - ACTIVE_ONLY - INACTIVE_ONLY default: UNKNOWN_ACTIVE_FILTER QueryPredefinedAudiencesWithAccessSummaryResponsePredefinedAudienceWithSummary: type: object properties: audience: $ref: '#/components/schemas/managementv1PredefinedAudience' visibility: $ref: '#/components/schemas/v1AudienceVisibilityType' accessible_ad_account_size: type: string format: uint64 title: Number of ad accounts that has direct access to it accessible_label_value_size: type: string format: uint64 title: Number of label values that has access to it required: - audience - visibility - accessible_ad_account_size additionalProperties: true QuerySpendCapsByAdAccountOverviewResponseSpendCapsByAdAccountOverview: type: object properties: ad_account_title: type: string ad_account_id: type: string description: The ad account id of the spend cap to be queried. ad_manager_account_title: type: string description: Should be empty when the feature is not using AMA feature. num_spend_caps: type: integer format: int64 additionalProperties: true QueryTopSellersOnboardingPlatformInsightDetailsResponseLargestSeller: type: object properties: id: type: string description: Unique identifier of the seller/ad account. title: type: string description: Title of the seller/ad account. gmv: $ref: '#/components/schemas/rmpcommonMoneyMicro' required: - gmv additionalProperties: true ReadCampaignForecastRequestForecastCampaignParams: type: object properties: id: type: string description: Campaign id. It is required for an existing campaign. ad_type: $ref: '#/components/schemas/ReadCampaignForecastRequestForecastCampaignParamsAdType' goal: $ref: '#/components/schemas/ReadCampaignForecastRequestForecastCampaignParamsCampaignGoal' budget: $ref: '#/components/schemas/rmpcommonBudget' item_option: $ref: '#/components/schemas/publicForecastCampaignCampaignItemOption' is_targeted: type: boolean description: If the forecasted campaign uses manual targeting. It should be true. description: ReadCampaignForecast request. required: - ad_type - goal - budget - item_option - is_targeted additionalProperties: true ReadCampaignForecastRequestForecastCampaignParamsAdType: type: string enum: - ITEM default: UNKNOWN_AD_TYPE description: This message follows same field number with AdType. ReadCampaignForecastRequestForecastCampaignParamsCampaignGoal: type: object properties: type: $ref: '#/components/schemas/ForecastCampaignParamsCampaignGoalCampaignGoalType' optimize_fixed_cpc: $ref: '#/components/schemas/ReadCampaignForecastRequestForecastCampaignParamsCampaignGoalOptimizeFixedCpc' optimize_roas: $ref: '#/components/schemas/ReadCampaignForecastRequestForecastCampaignParamsCampaignGoalOptimizeRoas' description: CampaignGoal describes which cost-metric goal a campaign aims for. required: - type additionalProperties: true ReadCampaignForecastRequestForecastCampaignParamsCampaignGoalOptimizeFixedCpc: type: object properties: target_cpc: $ref: '#/components/schemas/rmpcommonMoneyMicro' description: Detailed configuration of FIXED_CPC goal. required: - target_cpc additionalProperties: true ReadCampaignForecastRequestForecastCampaignParamsCampaignGoalOptimizeRoas: type: object properties: target_roas: type: integer format: int64 description: Target ROAS in percent. description: Detailed configuration of OPTIMIZE_ROAS goal. required: - target_roas additionalProperties: true ReadItemBasedCampaignGuidanceRequestItemBasedCampaignGuidanceParams: type: object properties: campaign_id: type: string description: Campaign id. It is required for an existing campaign. ad_type: $ref: '#/components/schemas/ReadItemBasedCampaignGuidanceRequestItemBasedCampaignGuidanceParamsAdType' goal_type: $ref: '#/components/schemas/ReadItemBasedCampaignGuidanceRequestItemBasedCampaignGuidanceParamsCampaignGoalType' item_option: $ref: '#/components/schemas/ReadItemBasedCampaignGuidanceRequestItemBasedCampaignGuidanceParamsCampaignItemOption' description: ReadItemBasedCampaignGuidanceRequest request. required: - ad_type - goal_type - item_option additionalProperties: true ReadItemBasedCampaignGuidanceRequestItemBasedCampaignGuidanceParamsAdType: type: string enum: - ITEM - BRAND default: UNKNOWN_AD_TYPE description: This message follows same field number with AdType. ReadItemBasedCampaignGuidanceRequestItemBasedCampaignGuidanceParamsCampaignGoalType: type: string enum: - UNKNOWN_GOAL_TYPE - FIXED_CPC - OPTIMIZE_ROAS - FIXED_CPM - MAXIMIZE_SALES default: UNKNOWN_GOAL_TYPE description: This message follows same field number with CampaignGoalType. ReadItemBasedCampaignGuidanceRequestItemBasedCampaignGuidanceParamsCampaignItemOption: type: object properties: include_all: type: boolean description: If true, include all items from the given AdAccountId regardless of what the ItemList contains. item_list: type: array items: type: string description: Item list for campaign guidance. It's required when the IncludeAll is false. excluded_item_list: type: array items: type: string description: When the IncludeAll is true, exclude the item from the list. item_selection_type: $ref: '#/components/schemas/CampaignCampaignItemSelectionType' smart_selection_setting: $ref: '#/components/schemas/CampaignItemSelectionSmartSelectionSetting' description: CampaignItemOption is used to specify the item list for campaign guidance. required: - include_all - item_selection_type additionalProperties: true ReadItemBasedCampaignGuidanceResponseConfidenceLevel: type: object properties: low_confidence_level: type: boolean description: If true, the confidence level is low. description: Confidence level of the guidance. additionalProperties: true ReadItemBasedCampaignGuidanceResponseGuidedMessage: type: object properties: guided_message_type: $ref: '#/components/schemas/GuidedMessageGuidedMessageType' description: GuidedMessage is used to include the message to guide the client. additionalProperties: true ReadItemBasedCampaignGuidanceResponseGuidedValue: type: object properties: guided_budget_micro: $ref: '#/components/schemas/publicUInt64Guidance' guided_bid_micro: $ref: '#/components/schemas/publicUInt64Guidance' guided_roas: $ref: '#/components/schemas/publicUInt32Guidance' description: GuidedValue is used to include the recommneded value. additionalProperties: true RememberDeviceConfigExpirationPolicy: type: string enum: - UNKNOWN_EXPIRATION_POLICY - 'OFF' - FOURTEEN_DAYS - THIRTY_DAYS default: UNKNOWN_EXPIRATION_POLICY description: "ExpirationPolicy defines the expiration period for trusted devices.\n\n - UNKNOWN_EXPIRATION_POLICY: Unknown\ \ expiration policy.\n - OFF: Trusted device feature is disabled.\n - FOURTEEN_DAYS: Trusted devices expire after\ \ 14 days.\n - THIRTY_DAYS: Trusted devices expire after 30 days." ReportConfigPlatformDashboardConfig: type: object properties: first_available_date: type: string category_level: type: integer format: int32 description: PlatformDashboard related configuration. additionalProperties: true RepresentedErrorDetail: type: object properties: type: type: string description: The type of the metadata. category: $ref: '#/components/schemas/commonErrorCategory' metadata: type: object description: The metadata of the responded error. additionalProperties: true required: - type - category additionalProperties: true RoleResourceType: type: string enum: - UNKNOWN_RESOURCE_TYPE - PLATFORM - AD_ACCOUNT default: UNKNOWN_RESOURCE_TYPE SearchConfigKeywordConfig: type: object properties: enabled_keyword_types: type: array items: $ref: '#/components/schemas/commonKeywordType' description: List of enabled keyword types. (e.g. [ALL, TARGET, BOOST]), Required. readOnly: true positive_keyword_config: $ref: '#/components/schemas/KeywordConfigPositiveKeywordConfig' negative_keyword_config: $ref: '#/components/schemas/KeywordConfigNegativeKeywordConfig' description: KeywordConfig contains the configuration related to the Keyword Targeting. required: - enabled_keyword_types additionalProperties: true SearchSettingKeywordSetting: type: object properties: keyword_type: $ref: '#/components/schemas/commonKeywordType' negative_keywords: type: array items: $ref: '#/components/schemas/KeywordSettingNegativeKeyword' description: Negative keyword settings. positive_keywords: type: array items: $ref: '#/components/schemas/KeywordSettingPositiveKeyword' description: Positive keyword settings. description: KeywordSetting describes target keyword targeting settings for the campaign required: - keyword_type additionalProperties: true SingleFilterSpendCapPeriodFilterValue: type: string enum: - UNKNOWN_SPEND_CAP_PERIOD_FILTER_VALUE - TOTAL - MONTHLY default: UNKNOWN_SPEND_CAP_PERIOD_FILTER_VALUE SingleFilterSpendCapPurposeFilterValue: type: string enum: - UNKNOWN_SPEND_CAP_PURPOSE_FILTER_VALUE - FUNDS - CREDITS default: UNKNOWN_SPEND_CAP_PURPOSE_FILTER_VALUE SmartSelectionConfigSelectionOption: type: string enum: - UNKNOWN_OPTION - SMART_SELECTION_AS_DEFAULT - MANUAL_SELECTION_AS_DEFAULT - SMART_SELECTION_AS_ONLY_OPTION default: UNKNOWN_OPTION SmartSelectionConfigSmartSelectionFilterConfiguration: type: object properties: max_num_excluded_items: type: integer format: int64 description: Maximum number of excluded item IDs allowed. 0 or absent means exclusion filter is not allowed. readOnly: true max_num_brands: type: integer format: int64 description: Maximum number of brands allowed in smart selection include filter. 0 or absent means brand filter is not allowed. readOnly: true max_num_categories: type: integer format: int64 description: Maximum number of categories allowed in smart selection include filter. 0 or absent means category filter is not allowed. readOnly: true on_sale_filter_enabled: type: boolean description: Whether the on-sale filter is enabled for smart selection. On-sale is a boolean toggle. readOnly: true description: Smart Selection V2 filter configuration for platform-level filtering constraints. A limit > 0 enables the filter; 0 or absent blocking the filter usage for a platform. additionalProperties: true SmartSelectionSettingExclude: type: object properties: item_ids: type: array items: type: string description: Canonical catalog item IDs to exclude from the selection. description: Exclusion filters for Smart Selection. additionalProperties: true SmartSelectionSettingInclude: type: object properties: brands: type: array items: type: string description: Brands to include. categories: type: array items: $ref: '#/components/schemas/SmartSelectionSettingIncludeCategoryPath' description: Category paths to include. Each path is a hierarchical list of levels. on_sale_only: type: boolean description: When true, only on-sale items are included. description: Inclusion filters for Smart Selection. additionalProperties: true SmartSelectionSettingIncludeCategoryPath: type: object properties: levels: type: array items: type: string description: Ordered category levels, e.g. ["Electronics", "Phones", "Smartphones"]. description: Hierarchical category path represented as ordered levels. additionalProperties: true SpendCapCampaignAssignmentScope: type: string enum: - UNKNOWN_CAMPAIGN_ASSIGNMENT_SCOPE - SELECTED_CAMPAIGNS - ALL_CAMPAIGNS default: UNKNOWN_CAMPAIGN_ASSIGNMENT_SCOPE description: 'CampaignAssignmentScope selects whether this SpendCap applies only to explicitly assigned campaigns or to every campaign in the owning ad account. Mirrors the AlloyDB enum {platform}.spend_cap_campaign_assignment_scope_enum.' SpendCapPurpose: type: string enum: - UNKNOWN_PURPOSE - ADVERTISER_FUNDS - CREDITS default: UNKNOWN_PURPOSE description: 'Purpose discriminates between SpendCaps representing the advertiser''s own funds (ADVERTISER_FUNDS, the default and historical behavior) and platform-issued credits (CREDITS). ADVERTISER_FUNDS on the public API maps to FUNDS on the internal storage proto.' SponsoredProductConfigFixedCPMConfig: type: object properties: bid_range: $ref: '#/components/schemas/rmpcommonMicroRange' target_purchase_for_new_campaign: type: integer format: int32 description: Target purchase count used for new campaign guidance interpolation. readOnly: true description: Fixed CPM configuration for item-based guidance. additionalProperties: true SponsoredProductConfigMaximizeSalesConfig: type: object properties: target_purchase_for_new_campaign: type: integer format: int32 description: Target purchase count used for new campaign guidance interpolation. readOnly: true description: Maximize Sales configuration for item-based guidance. additionalProperties: true SponsoredProductConfigOptimizedROASConfig: type: object properties: roas_range: $ref: '#/components/schemas/rmpcommonUInt32Range' target_purchase_for_new_campaign: type: integer format: int32 description: Target purchase count used for new campaign guidance interpolation. readOnly: true description: Optimized ROAS configuration for item-based guidance. additionalProperties: true StartMFAEnrollmentResponseManualEntry: type: object properties: secret: type: string description: Secret key for manual entry in TOTP authenticator apps. issuer: type: string description: Issuer name for manual entry in TOTP authenticator apps. description: Manual entry details for TOTP setup. required: - secret - issuer additionalProperties: true SuggestScenesResponseScene: type: object properties: title: type: string description: 'Short human-readable label for the scene. Example: "Modern Studio".' prompt: type: string description: Prompt that is fed into GenerateRequest.scene_prompt if the user picks this scene. description: A scene concept candidate. required: - title - prompt additionalProperties: true TargetingAudienceSetting: type: object properties: label: type: string description: Label of the audience settings. This can be set only if the event_based_include_list or event_based_exclude_list is set. This label will be used to identify the custom audience settings in the campaign. event_based_include_list: $ref: '#/components/schemas/AudienceSettingEventBasedList' event_based_exclude_list: $ref: '#/components/schemas/AudienceSettingEventBasedList' included_predefined_audience_list: $ref: '#/components/schemas/TargetingAudienceSettingPredefinedAudienceList' description: AudienceSetting describes audience targeting settings for the campaign additionalProperties: true TargetingAudienceSettingPredefinedAudience: type: object properties: id: type: string description: The id of the predefined audience. description: PredefinedAudience describes predefined audience used for the campaign. required: - id additionalProperties: true TargetingAudienceSettingPredefinedAudienceList: type: object properties: audiences: type: array items: $ref: '#/components/schemas/TargetingAudienceSettingPredefinedAudience' description: Predefined audiences. operator: $ref: '#/components/schemas/TargetingAudienceSettingPredefinedAudienceListOperator' description: PredefinedAudienceList describes predefined audiences used for the campaign. required: - audiences - operator additionalProperties: true TargetingAudienceSettingPredefinedAudienceListOperator: type: string enum: - UNKNOWN_OPERATOR - AND - OR default: UNKNOWN_OPERATOR TargetingConfigAudienceConfig: type: object properties: event_based_config_v2: $ref: '#/components/schemas/AudienceConfigEventBasedConfigV2' enabled_audience_types: type: array items: $ref: '#/components/schemas/TargetingConfigAudienceConfigAudienceType' description: The enabled audience types. readOnly: true predefined_config: $ref: '#/components/schemas/AudienceConfigPredefinedConfig' description: Audience Targeting configurations for the platform. required: - event_based_config_v2 additionalProperties: true TargetingConfigAudienceConfigAudienceType: type: string enum: - UNKNOWN_AUDIENCE_TYPE - CUSTOM - PREDEFINED default: UNKNOWN_AUDIENCE_TYPE TargetingConfigCustomConfig: type: object properties: custom_targets: type: array items: $ref: '#/components/schemas/TargetingConfigCustomConfigCustomTarget' description: List of custom targets. readOnly: true max_num_of_custom_targets: type: integer format: int64 description: The maximum number of custom targets. readOnly: true max_num_of_targetable_values_per_key: type: integer format: int64 description: The maximum number of targetable values per custom target key. readOnly: true description: CustomConfig contains the configuration related to the Custom Targeting. required: - custom_targets additionalProperties: true TargetingConfigCustomConfigCustomTarget: type: object properties: key_id: type: string description: The id of the custom target key. ad_serving_active: type: boolean description: The flag to indicate whether the custom target is active for ad serving. If false, the custom target is ignored for ad serving. readOnly: true is_optional: type: boolean description: If true, campaigns may omit this custom target key. additionalProperties: true TargetingConfigPlacementConfig: type: object properties: home_config: $ref: '#/components/schemas/PlacementConfigHomeConfig' category_config: $ref: '#/components/schemas/PlacementConfigCategoryConfig' search_config: $ref: '#/components/schemas/PlacementConfigSearchConfig' product_detail_config: $ref: '#/components/schemas/PlacementConfigProductDetailConfig' cart_config: $ref: '#/components/schemas/PlacementConfigCartConfig' checkout_config: $ref: '#/components/schemas/PlacementConfigCheckoutConfig' ranking_config: $ref: '#/components/schemas/TargetingConfigPlacementConfigRankingConfig' description: Placement Targeting configurations for the platform. additionalProperties: true TargetingConfigPlacementConfigRankingConfig: type: object properties: enabled: type: boolean description: Flag to enable the placement for RANKING PlacementType from campaign. readOnly: true description: RankingConfig contains the configuration related to the Ranking PlacementType. required: - enabled additionalProperties: true TargetingCustomSetting: type: object properties: custom_targets: type: array items: $ref: '#/components/schemas/TargetingCustomSettingCustomTarget' description: Custom targets. description: CustomSetting describes target custom targeting settings for the campaign required: - custom_targets additionalProperties: true TargetingCustomSettingCustomTarget: type: object properties: key_id: type: string description: The id of the custom target key. value_ids: type: array items: type: string description: The ids of the custom target values. description: CustomTarget describes target custom targeting for the campaign required: - key_id - value_ids additionalProperties: true TargetingPlacementSetting: type: object properties: home_setting: $ref: '#/components/schemas/PlacementSettingHomeSetting' category_setting: $ref: '#/components/schemas/PlacementSettingCategorySetting' search_setting: $ref: '#/components/schemas/PlacementSettingSearchSetting' product_detail_setting: $ref: '#/components/schemas/TargetingPlacementSettingProductDetailSetting' cart_setting: $ref: '#/components/schemas/PlacementSettingCartSetting' checkout_setting: $ref: '#/components/schemas/PlacementSettingCheckoutSetting' ranking_setting: $ref: '#/components/schemas/PlacementSettingRankingSetting' description: PlacementSetting describes target placement targeting settings for the campaign additionalProperties: true TargetingPlacementSettingProductDetailSetting: type: object properties: enabled: type: boolean description: If set true, the campaign will target the Product Detail Placement. cost_price: $ref: '#/components/schemas/rmpcommonMoneyMicro' description: Targeting setting of the Product Detail Placement. required: - enabled additionalProperties: true TopSellersNotOnboardedMetricTopSellersSegment: type: object properties: status: $ref: '#/components/schemas/TopSellersSegmentOnboardingStatus' count: type: integer format: int64 description: Number of top sellers with this onboarding status. additionalProperties: true TopSellersSegmentOnboardingStatus: type: string enum: - ONBOARDING_STATUS_UNKNOWN - ONBOARDING_STATUS_ADVERTISING - ONBOARDING_STATUS_NOT_ADVERTISING default: ONBOARDING_STATUS_UNKNOWN UpdateAdAccountStateInfoRequestAdAccountStateInfoParams: type: object properties: state: $ref: '#/components/schemas/v1AdAccountStateInfoAdAccountState' state_case: $ref: '#/components/schemas/AdAccountStateInfoStateCase' updated_at: type: string format: date-time description: Updated timestamp for the ad account. This should match the updated timestamp updated_at of the ad account, which is able to check with ReadAdAccount API. description: AdAccountState info. required: - state - state_case - updated_at additionalProperties: true UpdateInventoryRequestInventoryParams: type: object properties: id: type: string description: The id of the Inventory. title: type: string description: A descriptive name of the Inventory. decision_type: $ref: '#/components/schemas/v1InventoryDecisionType' updated_at: type: string format: date-time description: Updated timestamp. API user should not touch this field; it is set internally. creative_auction_setting: $ref: '#/components/schemas/managementv1CreativeAuctionSetting' access_permission_config_type: $ref: '#/components/schemas/managementv1InventoryAccessPermissionConfigType' public_access_config: $ref: '#/components/schemas/managementv1InventoryPublicAccessConfig' ad_accounts_allow_list_config: $ref: '#/components/schemas/managementv1InventoryAdAccountsAllowListConfig' restricted_config: $ref: '#/components/schemas/managementv1InventoryRestrictedConfig' description: Detailed information of the inventory. readOnly: true required: - id additionalProperties: true UpdateLabelValueAdAccountRelationshipBulkRequestUpdateType: type: string enum: - UNKNOWN - ASSIGN - UNASSIGN default: UNKNOWN UpdatePasswordRequestRequestType: type: string enum: - RESET_TOKEN - PASSWORD default: RESET_TOKEN description: "RequestType enumerates all types of update password request.\n\n - RESET_TOKEN: Request type that requires\ \ reset token.\n - PASSWORD: Request type that requires current password." UpdateSpendCapRequestSpendCapParams: type: object properties: title: type: string description: Title of spend cap. schedule: $ref: '#/components/schemas/rmpcommonTimeInterval' budget: $ref: '#/components/schemas/UpdateSpendCapRequestSpendCapParamsBudget' status: $ref: '#/components/schemas/UpdateSpendCapRequestSpendCapParamsSpendCapStatus' comment: type: string description: A reference comment for transaction. Optional. updated_at: type: string format: date-time description: Updated timestamp. This should match the updated timestamp updated_at of the spend cap, which is able to check with ReadSpendCap API. additionalProperties: true UpdateSpendCapRequestSpendCapParamsBudget: type: object properties: period: $ref: '#/components/schemas/UpdateSpendCapRequestSpendCapParamsBudgetPeriod' amount: $ref: '#/components/schemas/rmpcommonMoneyMicro' description: 'Budget is the SpendCap-specific budget shape. Intentionally separate from common.Budget (used by campaigns) so the Period enum can carry MONTHLY without leaking the value to campaign surfaces. The handler rejects any period change relative to the stored cap; only amount may be updated.' additionalProperties: true UpdateSpendCapRequestSpendCapParamsBudgetPeriod: type: string enum: - UNKNOWN_PERIOD - DAILY - WEEKLY - TOTAL default: UNKNOWN_PERIOD description: 'Numeric ordering groups the recurring kinds together (DAILY=1, WEEKLY=2, MONTHLY=3) with TOTAL=4 as the non-recurring case. Public mgmt access is REST/JSON-only and proto-JSON encodes enums by name, so the legacy binary numbering of common.Budget.Period is not relevant.' UpdateSpendCapRequestSpendCapParamsSpendCapStatus: type: string enum: - UNKNOWN_SPEND_CAP_STATUS - ACTIVE - INACTIVE default: UNKNOWN_SPEND_CAP_STATUS description: The only status that a user can update to is INACTIVE or ACTIVE. UpsertOrderWithLineItemsRequestOrderParams: type: object properties: id: type: string description: The id of the order. If present, the order will be updated; if absent, a new order will be created. title: type: string description: A descriptive name of the order. schedule: $ref: '#/components/schemas/commonOptionalTimeInterval' budget: $ref: '#/components/schemas/commonOptionalBudget' insertion_order_url: type: string description: URL of the insertion order. updated_at: type: string format: date-time description: Updated timestamp. Required when update request. draft: type: boolean description: Draft Save indicator. If true - order will be saved as draft item without actual launch ad_payer: type: string description: Free-text identifier of the party financially responsible for line items under this order (for compliance reporting). Optional; BE-enforced 200-character limit. description: List of params required to upsert an order. required: - title additionalProperties: true UserAccessChangeLogActivity: type: string enum: - UNKNOWN_ACTIVITY - GRANTED - REVOKED - CHANGED - INVITED - REGISTERED - DELETED - REQUESTED - REJECTED default: UNKNOWN_ACTIVITY UserDataDeletionRequestIdentifier: type: object properties: user_id: type: string description: User ID to be deleted. description: Identifier of the user to be deleted. required: - user_id additionalProperties: true UserRegistrationRegistrationInfo: type: object properties: email: type: string description: The email of the User. user_name: type: string description: The descriptive name of the user. role_names: type: array items: $ref: '#/components/schemas/v1RoleName' description: The role names that are granted to the User. description: Definition of a RegistrationInfo specification. readOnly: true required: - email - user_name additionalProperties: true ValidateAdAccountsBulkResponseAdAccountValidationResult: type: object properties: id: type: string description: Ad account ID. title: type: string description: Ad account title. error_type: $ref: '#/components/schemas/AdAccountValidationResultErrorType' description: Ad account validation result. required: - id - title additionalProperties: true campaignAdOperationType: type: string enum: - AD_OPERATION_TYPE_DEFAULT - AD_OPERATION_TYPE_SELF_SERVED - AD_OPERATION_TYPE_MANAGED default: AD_OPERATION_TYPE_DEFAULT commonAccountType: type: string enum: - UNKNOWN_ACCOUNT_TYPE - CREDITS - PRE_PAID default: UNKNOWN_ACCOUNT_TYPE description: "AccountType.\n\n - CREDITS: Account Type given as free.\n - PRE_PAID: Account Type pre paid." commonAdSchedule: type: object properties: dayparts: type: array items: $ref: '#/components/schemas/rmpcommonDayPart' description: Ad scheduling settings for a campaign or line item. required: - dayparts additionalProperties: true commonAsset: type: object properties: id: type: string description: The id of the asset. Must be left unset for the new asset. Must be set for the other requests. banner: $ref: '#/components/schemas/commonAssetBanner' logo: $ref: '#/components/schemas/commonAssetLogo' headline: $ref: '#/components/schemas/commonAssetHeadline' custom_text: $ref: '#/components/schemas/commonAssetCustomText' cta: $ref: '#/components/schemas/commonAssetCallToAction' metadata: $ref: '#/components/schemas/commonAssetMetadata' review_information: $ref: '#/components/schemas/commonReviewInformation' created_at: type: string format: date-time description: Created timestamp. API user should not touch this field; it is set internally. readOnly: true updated_at: type: string format: date-time description: This field represents the last time the asset was modified. The system sets this value internally for you when you create or update a asset, so make sure this value matches the latest updated_at you received from the Read API. description: Detailed settings for the asset. additionalProperties: true commonAssetBanner: type: object properties: creative_id: type: string description: ImageAsset ID referred to set the banner image target_inventory_dimension: $ref: '#/components/schemas/rmpcommonDimension' image_url: type: string description: The banner image URL. readOnly: true width: type: integer format: int64 description: The banner width (pixel). readOnly: true height: type: integer format: int64 description: The banner height (pixel). readOnly: true media_type: $ref: '#/components/schemas/rmpcommonMediaType' alt_text: type: string description: Alt-text for the banner image for accessibility. additionalProperties: true commonAssetCallToAction: type: object properties: text: type: string description: Call-To-Action text additionalProperties: true commonAssetCustomText: type: object properties: text: type: string description: Custom text content. color: type: string description: Hex color for custom text. Use a leading `#` plus 6 hex digits for RGB (e.g. `#FFFFFF`) or 8 hex digits for RGBA (e.g. `#FFFFFF00`). background_color: type: string description: Hex background color for custom text. Use a leading `#` plus 6 hex digits for RGB (e.g. `#FFFFFF`) or 8 hex digits for RGBA (e.g. `#FFFFFF00`). description: Custom text for the asset. additionalProperties: true commonAssetHeadline: type: object properties: text: type: string description: Headline text color: type: string description: Hex color for headline text. Use a leading `#` plus 6 hex digits for RGB (e.g. `#FFFFFF`) or 8 hex digits for RGBA (e.g. `#FFFFFF00`). background_color: type: string description: Hex background color for the headline. Use a leading `#` plus 6 hex digits for RGB (e.g. `#FFFFFF`) or 8 hex digits for RGBA (e.g. `#FFFFFF00`). additionalProperties: true commonAssetLogo: type: object properties: creative_id: type: string description: ImageAsset ID referred to set the logo image. image_url: type: string description: The logo image URL. additionalProperties: true commonAssetMetadata: type: object properties: attributes: type: object additionalProperties: type: string description: Key-value metadata attributes. additionalProperties: true commonBrandEntityType: type: string enum: - UNKNOWN_BRAND_ENTITY_TYPE - ASSET - LANDING_PAGE default: UNKNOWN_BRAND_ENTITY_TYPE commonCampaignEnablingState: type: string enum: - UNKNOWN_STATE - ENABLED - DISABLED default: UNKNOWN_STATE description: campaign’s enabling state that the advertiser can enable/disable. It will affect the campaign’s state. commonCampaignKeywordMatchType: type: string enum: - PHRASE - EXACT - BROAD default: PHRASE description: CampaignKeywordMatchType enumerates available match types for positive keyword targeting. commonCampaignLandingPage: type: object properties: type: $ref: '#/components/schemas/CampaignLandingPageCampaignLandingPageType' custom_url_setting: $ref: '#/components/schemas/CampaignLandingPageCustomUrlSetting' product_detail_setting: $ref: '#/components/schemas/commonCampaignLandingPageProductDetailSetting' product_list_setting: $ref: '#/components/schemas/CampaignLandingPageProductListSetting' id: type: string description: The id of the landing page. Must be left unset for the new landing page. Must be set for the other requests. review_information: $ref: '#/components/schemas/commonReviewInformation' created_at: type: string format: date-time description: Created timestamp. API user should not touch this field; it is set internally. readOnly: true updated_at: type: string format: date-time description: This field represents the last time the landing page was modified. The system sets this value internally for you when you create or update a landing page, so make sure this value matches the latest updated_at you received from the Read API. description: Detailed settings for the landing page. required: - type additionalProperties: true commonCampaignLandingPageProductDetailSetting: type: object properties: item_id: type: string description: Detailed configuration of the product detail page. required: - item_id additionalProperties: true commonCatalogItemAvailability: type: string enum: - UNKNOWN_AVAILABILITY - OUT_OF_STOCK default: UNKNOWN_AVAILABILITY description: CatalogItemAvailability enumerates available item availability. commonDateRange: type: object properties: date_start: type: string description: Date in 'YYYY-MM-DD' when summary begins. Inclusive. Note the allowed maximum duration for the date range is 186 days, to cover the period of any entire month. date_end: type: string description: Date in 'YYYY-MM-DD' when summary ends. Inclusive. Note the allowed maximum duration for the date range is 186 days, to cover the period of any entire month. additionalProperties: true commonErrorCategory: type: string enum: - DEFAULT_ERROR_CATEGORY - INPUT_VALIDATION - CHARACTER_LIMIT_EXCEEDED - TIMESTAMP_MISMATCH - FEATURE_NOT_ALLOWED - REINVITE_NOT_ALLOWED - LAST_OWNER_REVOKE_NOT_ALLOWED - LAST_OWNER_DELETE_NOT_ALLOWED - SSO_USER_JOIN_REQUEST_NOT_ALLOWED - MFA_VERIFICATION_FAILED - INSUFFICIENT_SPENDING_LIMIT - AD_ACCOUNT_ALREADY_OWNED - INSUFFICIENT_WALLET_BALANCE - INSUFFICIENT_SPEND_CAP_BUDGET - MAX_SPEND_CAP_COUNT_REACHED - MAX_CAMPAIGNS_COUNT_PER_SPEND_CAP_REACHED - MAX_CAMPAIGN_COUNT_REACHED - MODIFY_ARCHIVED_CAMPAIGN_NOT_ALLOWED - INVALID_CAMPAIGN_STATUS_FOR_ARCHIVE - INVALID_MANAGED_CPT_CAMPAIGN_SCHEDULE - INACTIVE_AD_ACCOUNT - DUPLICATE_AUDIENCE - INVALID_RESERVED_TIME_LINE_ITEM_SCHEDULE - EXCEED_MAX_IMAGE_SIZE - MAX_LABEL_COUNT_REACHED - MAX_LABEL_VALUE_COUNT_REACHED - MAX_LABEL_VALUE_RELATIONSHIP_COUNT_REACHED - PLATFORM_INSIGHT_UNAVAILABLE - MAX_CUSTOM_TARGETING_KEY_COUNT_REACHED - INVALID_CUSTOM_TARGETING default: DEFAULT_ERROR_CATEGORY title: "- INPUT_VALIDATION: INPUT_VALIDATION: reserved for 1 ~ 99\n - TIMESTAMP_MISMATCH: TIMESTAMP_MISSMATCH: reserved\ \ for 100 ~ 199\n - FEATURE_NOT_ALLOWED: General policy: 1000 ~ 1999\n - REINVITE_NOT_ALLOWED: User policy: 2000 ~\ \ 2999\n - INSUFFICIENT_SPENDING_LIMIT: Account policy: 3000 ~ 3999\nThis policy includes ad manager account, ad account,\ \ and wallet related policies\n - MAX_CAMPAIGN_COUNT_REACHED: Campaign policy: 4000 ~ 4999\n - INVALID_RESERVED_TIME_LINE_ITEM_SCHEDULE:\ \ Returned when a RESERVED_TIME line item's schedule overlaps an existing enabled RD booking on the same inventory.\n\ \ - EXCEED_MAX_IMAGE_SIZE: Asset policy: 5000 ~ 5999\n - MAX_LABEL_COUNT_REACHED: Labeling policy: 6000 ~ 6999\n -\ \ PLATFORM_INSIGHT_UNAVAILABLE: Insight metric policy: 7000 ~ 7999\n - MAX_CUSTOM_TARGETING_KEY_COUNT_REACHED: Custom\ \ Targeting policy: 8000 ~ 8999" commonHaloMetricDouble: type: object properties: direct: type: number format: double description: Metrics captured by direct attribution. indirect: type: number format: double description: Metrics captured by indirect attribution. total: type: number format: double description: Total metrics captured by direct + indirect attribution. additionalProperties: true commonHaloMetricInt: type: object properties: direct: type: string format: int64 description: Metrics captured by direct attribution. indirect: type: string format: int64 description: Metrics captured by indirect attribution. total: type: string format: int64 description: Total metrics captured by direct + indirect attribution. additionalProperties: true commonKeywordType: type: string enum: - ALL - TARGET default: ALL description: KeywordType enumerates available keyword types for keyword targeting. commonLabelValueEntityType: type: string enum: - UNKNOWN_ENTITY_FILTER - AD_ACCOUNT default: UNKNOWN_ENTITY_FILTER commonLineItemGoalType: type: string enum: - UNKNOWN_LINE_ITEM_GOAL_TYPE - RESERVED_IMPRESSIONS - RESERVED_TIME default: UNKNOWN_LINE_ITEM_GOAL_TYPE description: " - RESERVED_IMPRESSIONS: CPM-based Reserved Display: line item targets a fixed impression count at a set\ \ CPM.\n - RESERVED_TIME: CPT-based Reserved Display: line item owns 100% of targeted inventory for a fixed time window\ \ at a flat cost." commonOptionalBudget: type: object properties: period: $ref: '#/components/schemas/rmpcommonBudgetPeriod' amount: $ref: '#/components/schemas/rmpcommonMoneyMicro' description: Budget where all fields are optional. additionalProperties: true commonOptionalTimeInterval: 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 where all fields are optional. additionalProperties: true commonOrderByDirection: type: string enum: - UNKNOWN_ORDER_BY_DIRECTION - ASC - DESC default: UNKNOWN_ORDER_BY_DIRECTION commonPageInfo: type: object properties: page_index: type: integer format: int32 description: Current page we are at. page_size: type: integer format: int32 description: Number of items per page. pages_total: type: integer format: int32 description: Total number of pages. rows_total: type: integer format: int32 description: Total number of rows. description: Page information. required: - page_index - page_size - pages_total - rows_total additionalProperties: true commonReviewInformation: type: object properties: status: $ref: '#/components/schemas/commonReviewStatus' rejection_reason: type: string description: Review rejection reason updated_at: type: string format: date-time description: This field represents the last time the review was modified. The system sets this value internally for you when you create or update a review information, so make sure this value matches the latest updated_at you received from the Read API. additionalProperties: true commonReviewStatus: type: string enum: - UNKNOWN_REVIEW_STATUS - IN_REVIEW - APPROVED - REJECTED default: UNKNOWN_REVIEW_STATUS commonWalletType: type: string enum: - UNKNOWN_WALLET_TYPE - PRE_PAYMENT - POST_PAYMENT default: UNKNOWN_WALLET_TYPE description: "WalletType.\n\n - PRE_PAYMENT: Wallet type for Pre-payment use case\n - POST_PAYMENT: Wallet type for\ \ Post-payment use case" commonfilterFilterColumn: type: string enum: - UNKNOWN_FILTER_FIELD - IS_ACTIVE - CREATED_TIMESTAMP - CUSTOM_LABEL_0 - GTIN default: UNKNOWN_FILTER_FIELD commonfilterFilterOperator: type: string enum: - UNKNOWN_FILTER_OPERATOR - EQ - GT - GE - LT - LE - CONTAINS - IN default: UNKNOWN_FILTER_OPERATOR commonfilterQueryFilter: type: object properties: column: $ref: '#/components/schemas/commonfilterFilterColumn' filter_operator: $ref: '#/components/schemas/commonfilterFilterOperator' value: type: string description: 'Single value for filtering. Used with EQ, GE, LE operators. Examples: ''true''/''false'' for boolean, RFC3339 timestamp for CREATED_TIMESTAMP (e.g. ''2000-01-01T02:03:04.567890Z.)' values: type: array items: type: string description: Multiple values for filtering. To be used with IN operator. IN operator is only supported for Filter column. additionalProperties: true commonoffsiteAudienceType: type: string enum: - UNKNOWN_AUDIENCE - ONSITE - OFFSITE default: UNKNOWN_AUDIENCE description: " - ONSITE: Internal audience such as platform app/web inventories.\n - OFFSITE: External audience like\ \ audience extension." commonplatformAttributionWindow: type: string enum: - UNKNOWN_WINDOW - THIRTY_MINUTES_WINDOW - SIXTY_MINUTES_WINDOW - ONE_DAY_WINDOW - SEVEN_DAYS_WINDOW - FOURTEEN_DAYS_WINDOW - TWENTY_ONE_DAYS_WINDOW - TWENTY_EIGHT_DAYS_WINDOW - THIRTY_DAYS_WINDOW default: UNKNOWN_WINDOW commonplatformImageSetting: type: object properties: allowed_mimes: type: array items: type: string description: Allowed content mime types. readOnly: true max_size: type: integer format: int64 description: Maximum image file size in bytes. readOnly: true description: ImageSetting describes the configuration of the sponsored banner, especially for image type creatives. additionalProperties: true commonplatformSponsoredBrandConfig: type: object properties: asset_option: $ref: '#/components/schemas/platformAssetOption' landing_option: $ref: '#/components/schemas/platformLandingOption' auction_type: $ref: '#/components/schemas/platformAuctionType' cost_type: $ref: '#/components/schemas/platformCostType' cpc_setting: $ref: '#/components/schemas/platformCPCSetting' cpm_setting: $ref: '#/components/schemas/platformCPMSetting' budget_range: $ref: '#/components/schemas/rmpcommonMicroRange' targeting_config: $ref: '#/components/schemas/platformTargetingConfig' description: SponsoredBrandConfig describes the sponsored brand configurations. additionalProperties: true managementv1AdAccount: type: object properties: id: type: string description: The id of the ad account. This is a rmp-side truth. Thus it is always required, even for CreateAdAccountRequest. title: type: string description: A descriptive name of the ad account. timezone: type: string description: Timezone info of the ad account, Immutable. When there is no timezone info in ad account, Platform's timezone info will be applied. Must be in IANA timezone name format, e.g. Asia/Seoul. state_info: $ref: '#/components/schemas/v1AdAccountStateInfo' created_at: type: string format: date-time description: Created timestamp. API user should not touch this field; it is set internally. readOnly: true updated_at: type: string format: date-time description: Updated timestamp. Set internally during creation, but required during update. This should match the updated timestamp updated_at of the ad account, which is able to check with ReadAdAccount API. readOnly: true description: Definition of a ad account. required: - id - title - timezone - state_info - created_at - updated_at additionalProperties: true managementv1CampaignGoal: type: object properties: type: $ref: '#/components/schemas/rmpcommonCampaignGoalType' optimize_fixed_cpc: $ref: '#/components/schemas/managementv1CampaignGoalOptimizeFixedCpc' optimize_roas: $ref: '#/components/schemas/managementv1CampaignGoalOptimizeRoas' optimize_fixed_commission_rate: $ref: '#/components/schemas/CampaignGoalOptimizeFixedCommissionRate' optimize_fixed_cpm: $ref: '#/components/schemas/CampaignGoalOptimizeFixedCpm' maximize_sales: $ref: '#/components/schemas/CampaignGoalMaximizeSales' description: CampaignGoal describes which cost-metric goal a campaign aims for. required: - type additionalProperties: true managementv1CampaignGoalOptimizeFixedCpc: type: object properties: target_cpc: $ref: '#/components/schemas/rmpcommonMoneyMicro' description: Detailed configuration of FIXED_CPC goal. required: - target_cpc additionalProperties: true managementv1CampaignGoalOptimizeRoas: type: object properties: target_roas: type: integer format: int64 description: Target ROAS in percent. description: Detailed configuration of OPTIMIZE_ROAS goal. required: - target_roas additionalProperties: true managementv1CreativeAuctionSetting: type: object properties: image_setting: $ref: '#/components/schemas/managementv1CreativeAuctionSettingImageSetting' additionalProperties: true managementv1CreativeAuctionSettingImageSetting: type: object properties: allowed_dimension: $ref: '#/components/schemas/rmpcommonDimension' media_types: type: array items: $ref: '#/components/schemas/rmpcommonMediaType' description: Allowed media types for the inventory. required: - allowed_dimension additionalProperties: true managementv1Inventory: type: object properties: id: type: string description: The id of the Inventory. title: type: string description: A descriptive name of the Inventory. decision_type: $ref: '#/components/schemas/v1InventoryDecisionType' creative_auction_setting: $ref: '#/components/schemas/managementv1CreativeAuctionSetting' access_permission_config_type: $ref: '#/components/schemas/managementv1InventoryAccessPermissionConfigType' public_access_config: $ref: '#/components/schemas/managementv1InventoryPublicAccessConfig' ad_accounts_allow_list_config: $ref: '#/components/schemas/managementv1InventoryAdAccountsAllowListConfig' restricted_config: $ref: '#/components/schemas/managementv1InventoryRestrictedConfig' created_at: type: string format: date-time description: Created timestamp. API user should not touch this field; it is set internally. readOnly: true updated_at: type: string format: date-time description: Updated timestamp. API user should not touch this field; it is set internally. hidden: type: boolean description: Hidden indicates if the inventory is hidden. If true, the inventory will not be visible to the user. cost_type_floor: $ref: '#/components/schemas/managementv1InventoryCostTypeFloor' description: Detailed information of the inventory. readOnly: true required: - created_at additionalProperties: true managementv1InventoryAccessPermissionConfigType: type: string enum: - UNKNOWN_ACCESS_PERMISSION_TYPE - PUBLIC_ACCESS - AD_ACCOUNTS_ALLOW_LIST - RESTRICTED default: UNKNOWN_ACCESS_PERMISSION_TYPE managementv1InventoryAdAccountsAllowListConfig: type: object properties: allowed_ad_accounts: type: array items: type: string additionalProperties: true managementv1InventoryCostTypeFloor: type: object properties: cpc_bid_floor_micro: type: string format: int64 cpm_bid_floor_micro: type: string format: int64 cpp_commission_rate_floor: type: number format: double additionalProperties: true managementv1InventoryPublicAccessConfig: type: object additionalProperties: true managementv1InventoryRestrictedConfig: type: object additionalProperties: true managementv1Label: type: object properties: id: type: string description: The id of the label. name: type: string description: A descriptive name of the label. Required and unique across the platform. assignment_type: $ref: '#/components/schemas/LabelAssignmentType' created_at: type: string format: date-time description: Created timestamp. API user should not touch this field; it is set internally. readOnly: true updated_at: type: string format: date-time description: Updated timestamp. Set internally during creation, but required during update. This should match the updated timestamp updated_at of the label, which is able to check with ReadLabel API. readOnly: true description: Definition of a label. required: - id - name - assignment_type - created_at - updated_at additionalProperties: true managementv1PredefinedAudience: type: object properties: id: type: string description: The id of the predefined audience. label: type: string description: The label of the predefined audience. size: type: integer format: int64 description: The size of the predefined audience. valid: type: boolean description: The validity of the predefined audience. description: Definition of a predefined audience. required: - id - label - size - valid additionalProperties: true managementv1QueryFilter: type: object properties: column: $ref: '#/components/schemas/v1ReportSummaryFilterColumn' filter_operator: $ref: '#/components/schemas/v1ReportSummaryFilterOperator' value: type: string description: ID to be filtered by. To be used with EQ operator. values: type: array items: type: string description: IDs to be filtered by. To be used with IN operator. IN operator is only supported for Campaign Filter column. additionalProperties: true managementv1RememberDeviceConfig: type: object properties: expiration_policy: $ref: '#/components/schemas/RememberDeviceConfigExpirationPolicy' max_num_devices: type: integer format: int32 description: Maximum number of trusted devices per user. readOnly: true description: Configuration for 'Remember This Device' feature. required: - expiration_policy additionalProperties: true managementv1Role: type: object properties: name: $ref: '#/components/schemas/v1RoleName' resource_type: $ref: '#/components/schemas/RoleResourceType' resource_id: type: string description: The resource id that the Role is bound. description: Definition of a User Role specification. required: - name - resource_type - resource_id additionalProperties: true managementv1UseStatus: type: string enum: - UNKNOWN_USE_STATUS - PENDING - INACTIVE - ACTIVE default: UNKNOWN_USE_STATUS title: enum type for creative's use status in the campaign notificationv1Status: type: string enum: - UNKNOWN_STATUS - REQUESTED - PROCESSED - DELIVERED - READ - FAILED - OPTED_OUT - DROPPED default: UNKNOWN_STATUS description: ' - DROPPED: Terminal, non-error: delivery intentionally not sent (e.g. webhook endpoint deleted while a message was in flight). Distinct from FAILED (no oncall alarm).' platformAssetOption: type: object properties: banner_image_option: $ref: '#/components/schemas/AssetOptionBannerOption' logo_image_option: $ref: '#/components/schemas/AssetOptionLogoOption' headline_option: $ref: '#/components/schemas/AssetOptionHeadlineOption' custom_text_option: $ref: '#/components/schemas/AssetOptionCustomTextOption' cta_option: $ref: '#/components/schemas/AssetOptionCTAOption' bypass_asset_review: type: boolean description: The flag to bypass the asset review process. readOnly: true metadata_option: $ref: '#/components/schemas/AssetOptionMetadataOption' allow_no_banner_inventory: type: boolean description: Enables Product Carousel (no-banner inventories and related campaign relaxations) for this ad type. readOnly: true description: AssetOption describes the configuration for the asset. additionalProperties: true platformAttributionPolicy: type: string enum: - UNKNOWN_POLICY - DIRECT_POLICY - INDIRECT_AND_DIRECT_POLICY default: UNKNOWN_POLICY platformAuctionType: type: string enum: - UNKNOWN_AUCTION_TYPE - FIRST_PRICE - SECOND_PRICE - SELLER_AWARE_SECOND_PRICE default: UNKNOWN_AUCTION_TYPE platformBillingConfig: type: object properties: transaction_cutover_date: type: string description: Cut-over date for billing transactions. If set, all transactions will be processed through the v2 wallet system starting from this date. additionalProperties: true platformCPCSetting: type: object properties: cpc_range: $ref: '#/components/schemas/rmpcommonMicroRange' use_min_cpc_as_min_win_price: type: boolean description: UseMinCpcAsMinWinPrice indicates that WinPrice of CPC campaign can not be lower than Min of CpcRange. readOnly: true description: CPCSetting indicates the setting of the CPC type. additionalProperties: true platformCPMSetting: type: object properties: cpm_range: $ref: '#/components/schemas/rmpcommonMicroRange' use_min_cpm_as_min_win_price: type: boolean description: UseMinCpmAsMinWinPrice indicates that WinPrice of CPM campaign can not be lower than Min of CpmRange. readOnly: true description: CPMSetting indicates the setting of the CPM type. additionalProperties: true platformCPPSetting: type: object properties: commission_rate_range: $ref: '#/components/schemas/rmpcommonFloatingPointRange' attribution_window_minutes: type: integer format: int64 description: Attribution window for CPP. readOnly: true attribution_by_moloco: type: boolean description: Whether CPP attribution is done by Moloco. If false, attribution is done by platform by providing the associated decision track id in the purchase event. readOnly: true description: CPPSetting indicates the setting of the CPP type. additionalProperties: true platformCampaignQuotaConfig: type: object properties: max_num_of_catalog_item_ids: type: integer format: int64 description: Max number of catalog item IDs allowed per campaign (manual selection). Unset means the system default is used. readOnly: true description: Per-platform campaign quota configuration. additionalProperties: true platformCatalogConfig: type: object properties: feed_config: $ref: '#/components/schemas/CatalogConfigFeedConfig' description: CatalogConfig describes the catalog configurations of the platform. additionalProperties: true platformCatalogItemExternalIdAttribute: type: object properties: column_name: type: string description: The column name of the external ID in the catalog item schema. readOnly: true display_name: type: string description: The display name of the column name readOnly: true default_external_id: type: boolean description: The flag to indicate whether the external ID is default or not. readOnly: true description: CatalogItemExternalIdAttribute describes the configuration of the catalog item external IDs. additionalProperties: true platformCatalogItemProperty: type: string enum: - UNKNOWN_PROPERTY - DISCOUNT_PRICE - REVIEW_COUNT - RATING_SCORE default: UNKNOWN_PROPERTY platformCostType: type: string enum: - UNKNOWN_COST_TYPE - COST_PER_IMP - COST_PER_CLICK - COST_PER_PURCHASE - COST_PER_TIME default: UNKNOWN_COST_TYPE description: 'CostType indicates which event the platform charges advertisers. This field is only valid for ONSITE campaigns.' platformCreativeAttachmentDefault: type: string enum: - CREATIVE_ATTACHMENT_DEFAULT_UNSPECIFIED - UPLOAD - IMPORT - URL default: CREATIVE_ATTACHMENT_DEFAULT_UNSPECIFIED description: CreativeAttachmentDefault configures the default CTA for attaching a creative. platformGuidanceConfig: type: object properties: cpp_config: $ref: '#/components/schemas/GuidanceConfigCPPConfig' description: Guidance configurations for the platform. required: - cpp_config additionalProperties: true platformItemBasedGuidanceConfig: type: object properties: sponsored_brand_config: $ref: '#/components/schemas/platformItemBasedGuidanceConfigSponsoredBrandConfig' sponsored_product_config: $ref: '#/components/schemas/ItemBasedGuidanceConfigSponsoredProductConfig' eligible_item_ipv_threshold: type: integer format: int32 description: 'IPV threshold for filtering effective items. Items with page view count below this threshold are excluded from guidance calculations. Valid values: 1, 2, 5, 10, 20, 50, 100, 200, 300, 400, 500, 600, 700, 800, 900, 1000.' readOnly: true description: Item-based guidance configuration for the platform. additionalProperties: true platformItemBasedGuidanceConfigSponsoredBrandConfig: type: object properties: fixed_cpc_config: $ref: '#/components/schemas/ItemBasedGuidanceConfigSponsoredBrandConfigFixedCPCConfig' budget_config: $ref: '#/components/schemas/ItemBasedGuidanceConfigSponsoredBrandConfigBudgetConfig' description: Item-based guidance configuration for sponsored brand campaigns. additionalProperties: true platformLandingOption: type: object properties: custom_url_option: $ref: '#/components/schemas/LandingOptionCustomUrlOption' pdp_page_option: $ref: '#/components/schemas/LandingOptionProductDetailOption' product_listing_page_option: $ref: '#/components/schemas/LandingOptionProductListOption' bypass_landing_review: type: boolean description: The flag to bypass the landing review process. readOnly: true description: LandingOption describes the configuration for the landing. additionalProperties: true platformLandingUrlConfig: type: object properties: prefix: type: string description: Prefix of the landing url. readOnly: true default_suffix: type: string description: Default suffix of the landing url. readOnly: true description: LandingURL configurations for the platform. required: - prefix additionalProperties: true platformManagedConfig: type: object properties: enable_cpt_schedule_validation: type: boolean description: The flag whether schedule validation is enabled for CPT campaigns. readOnly: true product_config: $ref: '#/components/schemas/ManagedConfigProductConfig' creative_config: $ref: '#/components/schemas/ManagedConfigCreativeConfig' default_landing_page_url: type: string description: The default landing page URL for the Managed Ads UX. readOnly: true description: Managed Ads configurations for the platform. required: - enable_cpt_schedule_validation additionalProperties: true platformMonthlySetting: type: string enum: - UNKNOWN_DATE - FIRST - FIFTEENTH - TWENTYFIFTH - TWENTYSIXTH default: UNKNOWN_DATE description: Possible monthly reset date. Only 1st, 15th and 25th are available options. platformOnsiteAuctionConfig: type: object properties: auction_type: $ref: '#/components/schemas/platformAuctionType' cost_type: $ref: '#/components/schemas/platformCostType' cpc_setting: $ref: '#/components/schemas/platformCPCSetting' cpm_setting: $ref: '#/components/schemas/platformCPMSetting' cpp_setting: $ref: '#/components/schemas/platformCPPSetting' budget_range: $ref: '#/components/schemas/rmpcommonMicroRange' targeting_config: $ref: '#/components/schemas/platformTargetingConfig' optimize_roas_config: $ref: '#/components/schemas/platformOptimizeRoasConfig' description: OnsiteAuctionConfig describes the platform-wide onsite auction configuration. additionalProperties: true platformOnsiteCreativeAuctionConfig: type: object properties: auction_type: $ref: '#/components/schemas/platformAuctionType' cost_type: $ref: '#/components/schemas/platformCostType' image_setting: $ref: '#/components/schemas/commonplatformImageSetting' cpc_setting: $ref: '#/components/schemas/platformCPCSetting' cpm_setting: $ref: '#/components/schemas/platformCPMSetting' cpp_setting: $ref: '#/components/schemas/platformCPPSetting' approve_creatives_by_default: type: boolean description: The default creative approval setting. readOnly: true is_landing_url_required: type: boolean description: The flag to indicate that landing url is required. readOnly: true approve_landing_url_by_default: type: boolean description: The default landing url approval setting. readOnly: true budget_range: $ref: '#/components/schemas/rmpcommonMicroRange' description: OnsiteCreativeAuctionConfig describes the platform-wide creative onsite auction configuration. additionalProperties: true platformOptimizeRoasConfig: type: object properties: target_roas_range: $ref: '#/components/schemas/rmpcommonUInt32Range' description: OptimizeRoasConfig indicates the config of the OPTIMIZE_ROAS type. additionalProperties: true platformPredefinedAudienceConfig: type: object properties: use_audience_id: type: boolean description: The flag to indicate whether the audience id is used or not. readOnly: true data_source: $ref: '#/components/schemas/PredefinedAudienceConfigDataSource' sync_status: $ref: '#/components/schemas/PredefinedAudienceConfigSyncStatus' description: PredefinedAudienceConfig describes the configuration of the predefined audience. additionalProperties: true platformReportConfig: type: object properties: attribution_policy: $ref: '#/components/schemas/platformAttributionPolicy' attribution_window: $ref: '#/components/schemas/commonplatformAttributionWindow' platform_dashboard_config: $ref: '#/components/schemas/ReportConfigPlatformDashboardConfig' additionalProperties: true platformResetPeriodSetting: type: object properties: monthly_setting: $ref: '#/components/schemas/platformMonthlySetting' additionalProperties: true platformSmartSelectionConfig: type: object properties: selection_option: $ref: '#/components/schemas/SmartSelectionConfigSelectionOption' selection_filtering_configuration: $ref: '#/components/schemas/SmartSelectionConfigSmartSelectionFilterConfiguration' description: Smart Selection configurations for the platform. required: - selection_option additionalProperties: true platformSpendingLimitConfig: type: object properties: reset_period: $ref: '#/components/schemas/platformResetPeriodSetting' spending_limit_range: $ref: '#/components/schemas/rmpcommonMicroRange' spending_limit_range_by_currency: type: object additionalProperties: $ref: '#/components/schemas/rmpcommonMicroRange' description: Currency-specific spending limit range for multi-currency platforms. description: Spending Limit configurations for the platform. required: - reset_period - spending_limit_range additionalProperties: true platformSponsoredDisplayConfig: type: object properties: asset_option: $ref: '#/components/schemas/platformAssetOption' landing_option: $ref: '#/components/schemas/platformLandingOption' auction_type: $ref: '#/components/schemas/platformAuctionType' cost_type: $ref: '#/components/schemas/platformCostType' cpc_setting: $ref: '#/components/schemas/platformCPCSetting' cpm_setting: $ref: '#/components/schemas/platformCPMSetting' budget_range: $ref: '#/components/schemas/rmpcommonMicroRange' targeting_config: $ref: '#/components/schemas/platformTargetingConfig' description: SponsoredDisplayConfig describes the sponsored display configurations. additionalProperties: true platformTargetingConfig: type: object properties: placement_config: $ref: '#/components/schemas/TargetingConfigPlacementConfig' audience_config: $ref: '#/components/schemas/TargetingConfigAudienceConfig' custom_config: $ref: '#/components/schemas/TargetingConfigCustomConfig' description: Targeting configurations for the platform. additionalProperties: true protobufNullValue: type: string enum: - NULL_VALUE default: NULL_VALUE description: "`NullValue` is a singleton enumeration to represent the null value for the\n`Value` type union.\n\n The\ \ JSON representation for `NullValue` is JSON `null`.\n\n - NULL_VALUE: Null value." publicAcceptUserJoinRequestBulkResponse: type: object properties: results: type: array items: $ref: '#/components/schemas/AcceptUserJoinRequestBulkResponseAcceptUserJoinRequestResult' description: Bulk results for accept description: AcceptUserJoinRequestBulk response required: - results additionalProperties: true publicAcceptUserJoinRequestResponse: type: object additionalProperties: true publicApplySpendCapCampaignAssignmentChangesBFFResponse: type: object properties: effective_from: type: string format: date-time description: Timestamp from which the assignment change becomes effective. spend_cap_assignment: $ref: '#/components/schemas/ApplySpendCapCampaignAssignmentChangesBFFResponseSpendCapAssignmentChangeResult' campaign_assignment: $ref: '#/components/schemas/ApplySpendCapCampaignAssignmentChangesBFFResponseCampaignAssignmentChangeResult' additionalProperties: true publicCatalogFeedType: type: string enum: - UNKNOWN_FEED_TYPE - REFRESH - UPDATE default: UNKNOWN_FEED_TYPE title: RunCatalogFeed API messages publicChatResponse: type: object properties: message: type: string description: Assistant reply to the user. pending_prompt: type: string description: Backdrop-creation prompt the assistant has prepared for the user to confirm. Set when chat is ready to hand off to Generate. meta: $ref: '#/components/schemas/v1CreativeAgentResponseMeta' description: Chat response. required: - message - meta additionalProperties: true publicCheckPlatformSSOSecretResponse: type: object properties: exists: type: boolean description: Indicator of the existence of the SSO secret. description: ReadPlatformSSOSecret response required: - exists additionalProperties: true publicCreateAdAccountRequestAdAccountInfo: type: object properties: id: type: string description: The id of the ad account. Must be a string of 1 to 50 characters. Only letters (a–z, A–Z), digits (0–9), hyphens (-), underscores (_), and periods (.) are allowed. title: type: string description: A descriptive name of the ad account. timezone: type: string description: Timezone info of the ad account, Immutable. When there is no timezone info in ad account, Platform's timezone info will be applied. Must be in IANA timezone name format, e.g. Asia/Seoul. required: - id - title additionalProperties: true publicCreateAdAccountResponse: type: object properties: ad_account: $ref: '#/components/schemas/managementv1AdAccount' description: CreateAdAccount response. required: - ad_account additionalProperties: true publicCreateAdAccountUserRequestAdAccountUserParams: type: object properties: email: type: string description: The email of the Ad Account User, Immutable. name: type: string description: The name of the Ad Account User. If this field is not set, a parsed email will be used. role: $ref: '#/components/schemas/v1RoleName' required: - email - role additionalProperties: true publicCreateAdAccountUserResponse: type: object properties: user: $ref: '#/components/schemas/v1AdAccountUser' description: CreateAdAccountUser response required: - user additionalProperties: true publicCreateAdManagerAccountAndUserRequestAdManagerAccountInfo: type: object properties: title: type: string description: Title of the AdManagerAccount. managing_type: $ref: '#/components/schemas/v1AdManagerAccountManagingType' managing_ad_account_ids: type: array items: type: string description: AdAccount ids that the AdManagerAccount manages. required: - title - managing_type - managing_ad_account_ids additionalProperties: true publicCreateAdManagerAccountAndUserRequestAdManagerAccountUserInfo: type: object properties: email: type: string description: Email of the AdManagerAccountUser. name: type: string description: Name of the AdManagerAccountUser. If it is not given, it will be set as the parsed email. role: $ref: '#/components/schemas/v1RoleName' required: - email - role additionalProperties: true publicCreateAdManagerAccountAndUserResponse: type: object properties: ad_manager_account: $ref: '#/components/schemas/v1AdManagerAccount' user: $ref: '#/components/schemas/v1AdManagerAccountUser' description: CreateAdManagerAccountAndUser response. required: - ad_manager_account - user additionalProperties: true publicCreateAdManagerAccountRequestAdManagerAccountInfo: type: object properties: title: type: string description: Title of the AdManagerAccount. managing_type: $ref: '#/components/schemas/CreateAdManagerAccountRequestAdManagerAccountInfoManagingType' managing_ad_account_ids: type: array items: type: string description: List of ad account ids that the AdManagerAccount manages. description: AdManagerAccount info. required: - title - managing_type additionalProperties: true publicCreateAdManagerAccountResponse: type: object properties: ad_manager_account: $ref: '#/components/schemas/v1AdManagerAccount' description: CreateAdManagerAccount response. required: - ad_manager_account additionalProperties: true publicCreateAdManagerAccountUserRequestAdManagerAccountUserInfo: type: object properties: email: type: string description: The email of the Ad Manager Account User, Immutable. name: type: string description: The name of the Ad Manager Account User. If this field is not provided, parsed email will be used. role: $ref: '#/components/schemas/v1RoleName' description: AdManagerAccount User info. required: - email - role additionalProperties: true publicCreateAdManagerAccountUserResponse: type: object properties: user: $ref: '#/components/schemas/v1AdManagerAccountUser' description: CreateAdManagerAccountUser response. required: - user additionalProperties: true publicCreateBulkImageUploadSessionRequestFileInfo: type: object properties: file_name: type: string description: Original file name. mime_type: type: string description: MIME type of the file (e.g., image/png, image/jpeg). additionalProperties: true publicCreateBulkImageUploadSessionResponse: type: object properties: sessions: type: array items: $ref: '#/components/schemas/publicCreateBulkImageUploadSessionResponseSession' description: List of upload sessions with URLs and object keys. expires_at: type: string format: date-time description: Expiration time of session URL. description: Response containing upload session details. required: - sessions - expires_at additionalProperties: true publicCreateBulkImageUploadSessionResponseSession: type: object properties: upload_url: type: string description: Session URL for uploading the image file. object_key: type: string description: The object key where the image file will be stored. additionalProperties: true publicCreateBulkVideoUploadSessionRequestFileInfo: type: object properties: file_name: type: string description: Original file name. mime_type: type: string description: MIME type of the file (e.g., video/mp4). additionalProperties: true publicCreateBulkVideoUploadSessionResponse: type: object properties: sessions: type: array items: $ref: '#/components/schemas/publicCreateBulkVideoUploadSessionResponseSession' description: List of upload sessions with URLs and object keys. expires_at: type: string format: date-time description: Expiration time of session URL. description: CreateBulkVideoUploadSession response. required: - sessions - expires_at additionalProperties: true publicCreateBulkVideoUploadSessionResponseSession: type: object properties: upload_url: type: string description: Session URL for uploading the video file. object_key: type: string description: The object key where the video file will be stored. additionalProperties: true publicCreateCampaignRequestCampaignParams: type: object properties: title: type: string description: A descriptive name of the campaign. hidden: type: boolean description: 'if this value is true, it means that a campaign is no longer visible and has been archived. Only disabled or ended campaigns could be hidden. Optional(Default: False).' ad_type: $ref: '#/components/schemas/rmpcommonAdType' schedule: $ref: '#/components/schemas/rmpcommonTimeInterval' daily_budget: $ref: '#/components/schemas/rmpcommonMoneyMicro' budget: $ref: '#/components/schemas/rmpcommonBudget' targeting: $ref: '#/components/schemas/v1Targeting' goal: $ref: '#/components/schemas/managementv1CampaignGoal' catalog_item_ids: type: array items: type: string description: List of catalog items belonging to the campaign. Required when the campaign is MANUAL_SELECTION item selection type. A catalog item id can be a product id or deal id in the catalogs. Note that an item can belong to multiple campaigns. enabling_state: $ref: '#/components/schemas/commonCampaignEnablingState' item_selection: $ref: '#/components/schemas/CampaignCampaignItemSelection' assets: type: array items: $ref: '#/components/schemas/publicCreateCampaignRequestCampaignParamsAssetParams' description: Assets information for the brand campaign. landing_pages: type: array items: $ref: '#/components/schemas/publicCreateCampaignRequestCampaignParamsCampaignLandingPageParams' description: Landing pages information for the brand campaign. spend_cap_id: type: string description: The id of the spend cap. If set, the campaign will be associated with the spend cap. ad_operation_type: $ref: '#/components/schemas/campaignAdOperationType' alias: type: string description: The alias is the platform-defined identifier for the campaign. description: List of params required to create a campaign. required: - schedule - ad_type - goal - enabling_state additionalProperties: true publicCreateCampaignRequestCampaignParamsAssetParams: type: object properties: banner: $ref: '#/components/schemas/commonAssetBanner' logo: $ref: '#/components/schemas/commonAssetLogo' headline: $ref: '#/components/schemas/commonAssetHeadline' custom_text: $ref: '#/components/schemas/commonAssetCustomText' cta: $ref: '#/components/schemas/commonAssetCallToAction' description: Detailed settings for the campaign asset. additionalProperties: true publicCreateCampaignRequestCampaignParamsCampaignLandingPageParams: type: object properties: type: $ref: '#/components/schemas/CampaignLandingPageCampaignLandingPageType' custom_url_setting: $ref: '#/components/schemas/CampaignLandingPageCustomUrlSetting' product_detail_setting: $ref: '#/components/schemas/commonCampaignLandingPageProductDetailSetting' product_list_setting: $ref: '#/components/schemas/CampaignLandingPageProductListSetting' description: Detailed settings for the landing page. required: - type additionalProperties: true publicCreateCampaignResponse: type: object properties: campaign: $ref: '#/components/schemas/v1Campaign' description: CreateCampaign response. required: - campaign additionalProperties: true publicCreateCampaignReviewResponse: type: object properties: campaign_review: $ref: '#/components/schemas/v1CampaignReview' description: CreateCampaignReview response. required: - campaign_review additionalProperties: true publicCreateCreativeAgentUploadSessionResponse: type: object properties: upload_url: type: string description: URL the FE PUTs the source image bytes to. read_url: type: string description: URL the FE renders the uploaded image with and passes into messages. Returns 404 until the upload completes. expires_at: type: string format: date-time description: Expiration of the signed URLs. description: CreateCreativeAgentUploadSession response. required: - upload_url - read_url - expires_at additionalProperties: true publicCreateCreativeRequestUploadCreativeRequest: type: object properties: file_bytes: type: string format: byte description: The file bytes. readOnly: true mime_type: type: string description: The mime type. readOnly: true file_name: type: string description: The file name. readOnly: true creative: $ref: '#/components/schemas/publicCreateCreativeRequestUploadCreativeRequestCreativeParams' description: Parameters to upload creative. required: - creative additionalProperties: true publicCreateCreativeRequestUploadCreativeRequestCreativeParams: type: object properties: title: type: string description: A descriptive name of the creative. type: $ref: '#/components/schemas/v1CreativeType' image_source: $ref: '#/components/schemas/publicCreativeImageSourceParams' description: Definition of a creative. required: - type additionalProperties: true publicCreateCreativeResponse: type: object properties: creative: $ref: '#/components/schemas/v1Creative' description: CreateCreative response. required: - creative additionalProperties: true publicCreateDelegatorTokenResponse: type: object properties: token: type: string description: The token which is used to auth RMP service. user: $ref: '#/components/schemas/v1RawUser' expires_at: type: string format: date-time description: Expiration timestamp of issued token. RFC3339 format, e.g. '2000-01-01T02:03:04.567890Z' description: CreateDelegatorToken response required: - token - user - expires_at additionalProperties: true publicCreateImageAssetRequestUploadSessionUrl: type: object properties: object_key: type: string description: Base64 encoded object key of the uploaded file. description: ImageAsset creation using files uploaded via upload session URLs. required: - object_key additionalProperties: true publicCreateImageAssetResponse: type: object properties: image_asset: $ref: '#/components/schemas/v1ImageAsset' description: CreateImageAsset response. required: - image_asset additionalProperties: true publicCreateLabelRequestLabelParams: type: object properties: name: type: string description: A descriptive name of the label. Required and unique across the platform. assignment_type: $ref: '#/components/schemas/LabelAssignmentType' description: Parameters for creating a label. required: - name - assignment_type additionalProperties: true publicCreateLabelResponse: type: object properties: label: $ref: '#/components/schemas/managementv1Label' description: CreateLabel response. required: - label additionalProperties: true publicCreateLabelValueRequestLabelValueParams: type: object properties: name: type: string description: A descriptive name of the value. Required. description: Parameters for creating a label value. required: - name additionalProperties: true publicCreateLabelValueResponse: type: object properties: label_value: $ref: '#/components/schemas/v1LabelValue' description: CreateLabelValue response. required: - label_value additionalProperties: true publicCreateLandingUrlResponse: type: object properties: landing_url: $ref: '#/components/schemas/v1LandingUrl' description: CreateLandingUrl response. required: - landing_url additionalProperties: true publicCreateManagedCampaignsBulkRequestCampaignParams: type: object properties: title: type: string description: A descriptive name of the campaign. hidden: type: boolean description: 'if this value is true, it means that a campaign is no longer visible and has been archived. Only disabled or ended campaigns could be hidden. Optional(Default: False).' ad_type: $ref: '#/components/schemas/rmpcommonAdType' schedule: $ref: '#/components/schemas/rmpcommonTimeInterval' daily_budget: $ref: '#/components/schemas/rmpcommonMoneyMicro' budget: $ref: '#/components/schemas/rmpcommonBudget' targeting: $ref: '#/components/schemas/v1Targeting' goal: $ref: '#/components/schemas/managementv1CampaignGoal' catalog_item_ids: type: array items: type: string description: List of catalog items belonging to the campaign. A catalog item id can be a product id or deal id in the catalogs. Note that an item can belong to multiple campaigns. enabling_state: $ref: '#/components/schemas/commonCampaignEnablingState' assets: type: array items: $ref: '#/components/schemas/publicCreateManagedCampaignsBulkRequestCampaignParamsAssetParams' description: Assets information for the brand campaign. landing_pages: type: array items: $ref: '#/components/schemas/publicCreateManagedCampaignsBulkRequestCampaignParamsCampaignLandingPageParams' description: Landing pages information for the brand campaign. description: List of params required to create a campaign. required: - schedule - ad_type - goal - catalog_item_ids - enabling_state additionalProperties: true publicCreateManagedCampaignsBulkRequestCampaignParamsAssetParams: type: object properties: banner: $ref: '#/components/schemas/commonAssetBanner' logo: $ref: '#/components/schemas/commonAssetLogo' headline: $ref: '#/components/schemas/commonAssetHeadline' custom_text: $ref: '#/components/schemas/commonAssetCustomText' cta: $ref: '#/components/schemas/commonAssetCallToAction' description: Detailed settings for the campaign asset. additionalProperties: true publicCreateManagedCampaignsBulkRequestCampaignParamsCampaignLandingPageParams: type: object properties: type: $ref: '#/components/schemas/CampaignLandingPageCampaignLandingPageType' custom_url_setting: $ref: '#/components/schemas/CampaignLandingPageCustomUrlSetting' product_detail_setting: $ref: '#/components/schemas/commonCampaignLandingPageProductDetailSetting' product_list_setting: $ref: '#/components/schemas/CampaignLandingPageProductListSetting' description: Detailed settings for the landing page. required: - type additionalProperties: true publicCreateManagedCampaignsBulkResponse: type: object properties: campaigns: type: array items: $ref: '#/components/schemas/v1Campaign' description: Campaigns info. description: CreateManagedCampaignsBulk response. required: - campaigns additionalProperties: true publicCreateOffsiteCampaignRequestOffsiteCampaignParams: type: object properties: title: type: string description: A descriptive name. Required. channel_settings: type: array items: $ref: '#/components/schemas/v1OffsiteChannelSetting' description: 'Requested channel intent. M1: exactly one entry with channel = OFFSITE_CHANNEL_GOOGLE.' description: 'Editable fields the seller supplies on Create. The id is server-assigned, archived defaults to false, offsite_executions[] is output-only, and created_at / updated_at are server-managed — none appear here.' required: - title - channel_settings additionalProperties: true publicCreateOffsiteCampaignResponse: type: object properties: offsite_campaign: $ref: '#/components/schemas/v1OffsiteCampaign' required: - offsite_campaign additionalProperties: true publicCreatePlatformAPIKeyRequestAPIKeyParams: type: object properties: type: $ref: '#/components/schemas/APIKeyAPIKeyType' name: type: string description: Name for the APIKey. Length limited to 128. expiration_timestamp: type: string format: date-time description: Expiration timestamp for the key. required: - type - name additionalProperties: true publicCreatePlatformAPIKeyResponse: type: object properties: api_key: $ref: '#/components/schemas/publicCreatePlatformAPIKeyResponseAPIKeyParams' description: CreatePlatformAPIKey response required: - api_key additionalProperties: true publicCreatePlatformAPIKeyResponseAPIKeyParams: type: object properties: type: $ref: '#/components/schemas/APIKeyAPIKeyType' name: type: string description: Name for the APIKey. Length limited to 128. key: type: string description: Raw key for the APIKey. expiration_timestamp: type: string format: date-time description: Expiration timestamp for the key. required: - type - name - expiration_timestamp additionalProperties: true publicCreatePlatformSSOSecretResponse: type: object properties: sso_secret: type: string description: Raw string of SSO secret. description: CreatePlatformSSOSecret response required: - sso_secret additionalProperties: true publicCreateResetTokenPublicResponse: type: object description: CreateResetTokenPublic response additionalProperties: true publicCreateResetTokenResponse: type: object description: CreateResetToken response additionalProperties: true publicCreateSpendCapRequestBudget: type: object properties: period: $ref: '#/components/schemas/publicCreateSpendCapRequestBudgetPeriod' amount: $ref: '#/components/schemas/rmpcommonMoneyMicro' description: 'Budget is the SpendCap-specific budget shape. Intentionally separate from common.Budget (used by campaigns) so the Period enum can carry MONTHLY without leaking the value to campaign surfaces.' additionalProperties: true publicCreateSpendCapRequestBudgetPeriod: type: string enum: - UNKNOWN_PERIOD - DAILY - WEEKLY - TOTAL default: UNKNOWN_PERIOD description: 'Numeric ordering groups the recurring kinds together (DAILY=1, WEEKLY=2, MONTHLY=3) with TOTAL=4 as the non-recurring case. Public mgmt access is REST/JSON-only and proto-JSON encodes enums by name, so the legacy binary numbering of common.Budget.Period is not relevant here.' publicCreateSpendCapResponse: type: object properties: spend_cap: $ref: '#/components/schemas/v1SpendCap' additionalProperties: true publicCreateSpendingLimitResponse: type: object properties: spending_limit: $ref: '#/components/schemas/v1SpendingLimit' description: CreateSpendingLimit response. additionalProperties: true publicCreateTokenFromSAMLResponseResponse: type: object properties: token: type: string description: JWT token created from the SAML response. relay_state: type: string description: Relay state for the SAML response. expires_at: type: string format: date-time description: Expiration time of the token. user: $ref: '#/components/schemas/v1User' description: Response containing the created token from the SAML response. required: - token - expires_at - user additionalProperties: true publicCreateTokenResponse: type: object properties: token: type: string description: The token which is used to auth RMP service. expires_at: type: string format: date-time description: Expiration timestamp of issued token. RFC3339 format, e.g. '2000-01-01T12:34:56+00:00' user: $ref: '#/components/schemas/v1User' description: CreateToken response required: - token - expires_at additionalProperties: true publicCreateUserJoinRequestResponse: type: object properties: user_join_request: $ref: '#/components/schemas/v1UserJoinRequest' description: CreateUserJoinRequest response required: - user_join_request additionalProperties: true publicCreateUserRequestUserParams: type: object properties: email: type: string description: The email of the User, Immutable. name: type: string description: The name of the User. If this field is not set, a parsed email will be used. roles: type: array items: $ref: '#/components/schemas/managementv1Role' description: The roles that are granted to the User. required: - email additionalProperties: true publicCreateUserResponse: type: object properties: user: $ref: '#/components/schemas/v1User' description: CreateUser response required: - user additionalProperties: true publicCreateVideoAssetRequestUploadSessionUrl: type: object properties: object_key: type: string additionalProperties: true publicCreateVideoAssetResponse: type: object properties: video_asset: $ref: '#/components/schemas/v1VideoAsset' description: CreateVideoAsset response. required: - video_asset additionalProperties: true publicCreateWalletResponse: type: object properties: wallet: $ref: '#/components/schemas/v1Wallet' description: CreateWallet response. additionalProperties: true publicCreateWebhookEndpointRequestWebhookEndpointParams: type: object properties: url: type: string description: The HTTPS URL that deliveries are POSTed to. description: type: string description: Human-readable description of the endpoint. Optional. subscribed_events: type: array items: $ref: '#/components/schemas/v1WebhookEvent' description: The webhook events this endpoint is subscribed to. enabled: type: boolean description: Whether the endpoint is enabled. Disabled endpoints do not receive deliveries. retry_policy: $ref: '#/components/schemas/v1WebhookRetryPolicy' name: type: string description: Human-readable display name of the endpoint. Optional. description: 'Editable params supplied on create. The id is server-assigned and created_at / updated_at are server-managed, so none appear here.' required: - url - subscribed_events - enabled additionalProperties: true publicCreateWebhookEndpointResponse: type: object properties: webhook_endpoint: $ref: '#/components/schemas/v1WebhookEndpoint' description: CreateWebhookEndpoint response. required: - webhook_endpoint additionalProperties: true publicCreateWebhookSigningKeyResponse: type: object properties: signing_key: $ref: '#/components/schemas/v1WebhookSigningKey' secret: type: string description: The raw signing secret. Returned at creation; re-fetchable for ACTIVE keys via RevealWebhookSigningKey. description: CreateWebhookSigningKey response. The raw secret is returned at creation and can be re-fetched for ACTIVE keys via RevealWebhookSigningKey. required: - signing_key - secret additionalProperties: true publicCreativeAgentLoopRequestOutput: type: object properties: max_bytes: type: integer format: int64 description: Maximum byte size of the encoded output, from platform's banner_image_option.max_size. allowed_mime_types: type: array items: type: string description: Allowed mime types for the encoded output, from platform's banner_image_option.allowed_mimes. description: Output constraints derived from the platform's banner image option. required: - max_bytes - allowed_mime_types additionalProperties: true publicCreativeAgentLoopRequestTargetDimension: type: object properties: width: type: integer format: int32 description: Output width in pixels. height: type: integer format: int32 description: Output height in pixels. description: 'Exact pixel dimensions the generated creative must match. Range: 256-4096 per side.' required: - width - height additionalProperties: true publicCreativeAgentLoopResponse: type: object properties: text: type: string description: Assistant text for the turn. May be empty when the turn ends with tool output only. tool_results: type: array items: type: object additionalProperties: true description: 'Tool calls executed during the turn, in execution order, verbatim from creativesvc: {toolCallId, toolName, input, output}. The FE folds them into the assistant UIMessage for the next turn''s messages.' description: CreativeAgentLoop response. required: - text - tool_results additionalProperties: true publicCreativeImageSourceParams: type: object properties: url: type: string description: The URL of the image. file_name: type: string description: The file name of the image. description: Params to upload image via url. additionalProperties: true publicCredits: type: object properties: credits: type: array items: $ref: '#/components/schemas/v1Credit' description: List of Credits. description: QueryCredits response. required: - credits additionalProperties: true publicDeleteAdAccountResponse: type: object description: DeleteAdAccount response. additionalProperties: true publicDeleteAdAccountUserResponse: type: object additionalProperties: true publicDeleteAdManagerAccountResponse: type: object description: DeleteAdManagerAccount response. additionalProperties: true publicDeleteAdManagerAccountUserResponse: type: object description: DeleteAdManagerAccountUser response. additionalProperties: true publicDeleteAllTrustedDevicesResponse: type: object additionalProperties: true publicDeleteCampaignResponse: type: object description: DeleteCampaign response. additionalProperties: true publicDeleteLabelResponse: type: object description: DeleteLabel response. additionalProperties: true publicDeleteLabelValueResponse: type: object description: DeleteLabelValue response. additionalProperties: true publicDeleteLineItemResponse: type: object description: DeleteLineItem response. additionalProperties: true publicDeleteOrderResponse: type: object description: DeleteOrder response. additionalProperties: true publicDeletePlatformAPIKeyResponse: type: object additionalProperties: true publicDeletePlatformSSOSecretResponse: type: object additionalProperties: true publicDeleteTrustedDeviceResponse: type: object additionalProperties: true publicDeleteUserResponse: type: object additionalProperties: true publicDeleteWebhookEndpointResponse: type: object additionalProperties: true publicDenyUserJoinRequestBulkResponse: type: object properties: results: type: array items: $ref: '#/components/schemas/DenyUserJoinRequestBulkResponseDenyUserJoinRequestResult' description: Bulk results for deny description: DenyUserJoinRequestBulk response required: - results additionalProperties: true publicDenyUserJoinRequestResponse: type: object additionalProperties: true publicDescribeCatalogItemResponse: type: object properties: description: type: string description: Short text description of the catalog item image. meta: $ref: '#/components/schemas/v1CreativeAgentResponseMeta' description: DescribeCatalogItem response. required: - description - meta additionalProperties: true publicDeviceFingerprint: type: object properties: os: type: string description: Operating system of the device. browser: type: string description: Browser used on the device. ip_address: type: string description: IP address of the device when last used. description: Device fingerprint information. required: - ip_address additionalProperties: true publicDoubleGuidance: type: object properties: value: type: number format: double description: Value of the guidance. min: type: number format: double description: Minimum value of the guidance. max: type: number format: double description: Maximum value of the guidance. description: Guidance for double value. It is used for increment ratio guidance. required: - value - min - max additionalProperties: true publicExpectedGuidanceMetric: type: object properties: type: $ref: '#/components/schemas/publicExpectedGuidanceMetricMetricType' increment_ratio: $ref: '#/components/schemas/publicDoubleGuidance' required: - type - increment_ratio additionalProperties: true publicExpectedGuidanceMetricMetricType: type: string enum: - UNKNOWN_METRIC - IMPRESSION - CLICK - PURCHASE default: UNKNOWN_METRIC description: "MetricType enumerates all types of metric.\n\n - IMPRESSION: The metric type for impression.\n - CLICK:\ \ The metric type for click.\n - PURCHASE: The metric type for purchase." publicExportSpendingLimitCreditHistoryResponse: type: object properties: transaction_histories: type: array items: $ref: '#/components/schemas/v1SpendingLimitCreditHistory' description: List of SpendingLimitCreditHistory. description: ExportSpendingLimitCreditHistory response. required: - transaction_histories additionalProperties: true publicExportWalletTransactionHistoryResponse: type: object properties: transaction_histories: type: array items: $ref: '#/components/schemas/v1WalletTransactionHistory' description: List of WalletTransactionHistory. description: ExportWalletTransactionHistory response. required: - transaction_histories additionalProperties: true publicForecastCampaignCampaignItemOption: type: object properties: item_list: type: array items: type: string description: Item list for campaign forecast. It's required when the IncludeAll is false. include_all: type: boolean description: If true, include all items from the given AdAccountId regardless of what the ItemList contains. excluded_item_list: type: array items: type: string description: When the IncludeAll is true, exclude the item from the list. The maximum number of items is 5000. item_selection_type: $ref: '#/components/schemas/CampaignCampaignItemSelectionType' smart_selection_setting: $ref: '#/components/schemas/CampaignItemSelectionSmartSelectionSetting' description: CampaignItemOption is used to specify the item list for campaign forecast. additionalProperties: true publicForecastValue: type: object properties: min: type: string format: int64 description: Minimum value of the forecast. max: type: string format: int64 description: Maximum value of the forecast. description: Forecast value with range. required: - min - max additionalProperties: true publicGenerateRequestOutput: type: object properties: max_bytes: type: integer format: int64 description: Maximum byte size of the encoded output, from platform's banner_image_option.max_size. allowed_mime_types: type: array items: type: string description: Allowed mime types for the encoded output, from platform's banner_image_option.allowed_mimes. description: Output constraints derived from the platform's banner image option. required: - max_bytes - allowed_mime_types additionalProperties: true publicGenerateRequestTargetDimension: type: object properties: width: type: integer format: int32 description: Output width in pixels. Must be positive. height: type: integer format: int32 description: Output height in pixels. Must be positive. description: Exact pixel dimensions the output image must match. required: - width - height additionalProperties: true publicGenerateResponse: type: object properties: image_data: type: string description: Base64 data URI of the generated image. meta: $ref: '#/components/schemas/v1CreativeAgentResponseMeta' description: Generate response. required: - image_data - meta additionalProperties: true publicGetCatalogFeedSyncOverviewBFFResponse: type: object properties: sync_health: $ref: '#/components/schemas/GetCatalogFeedSyncOverviewBFFResponseSyncHealth' last_run: $ref: '#/components/schemas/v1CatalogHistory' last_successful_run: $ref: '#/components/schemas/v1CatalogHistory' available_feed_types: type: array items: $ref: '#/components/schemas/publicCatalogFeedType' description: Feed types for which an ingestion pipeline exists for this platform's catalog. next_scheduled_run_at: type: string format: date-time description: Soonest upcoming cron-scheduled run across all available feed types. additionalProperties: true publicGetCatalogFeedValidationResponse: type: object properties: url: type: string description: Temporary URL for downloading the validation error report file. This URL expires after a limited time. expired_at: type: string format: date-time description: UTC timestamp when the URL expires. ad_account_items_url: type: string description: Temporary URL for downloading the ad account items validation error report file (MSPI only). This URL expires after a limited time. ad_account_items_expired_at: type: string format: date-time description: UTC timestamp when the ad account items URL expires (MSPI only). additionalProperties: true publicGetOffsiteAdAccountBudgetResponse: type: object properties: budget: $ref: '#/components/schemas/GetOffsiteAdAccountBudgetResponseOffsiteAccountBudget' additionalProperties: true publicGoogleOffsiteDataState: type: string enum: - GOOGLE_OFFSITE_DATA_STATE_UNSPECIFIED - GOOGLE_OFFSITE_DATA_STATE_FRESH - GOOGLE_OFFSITE_DATA_STATE_STALE - GOOGLE_OFFSITE_DATA_STATE_NO_DATA - GOOGLE_OFFSITE_DATA_STATE_UNAVAILABLE default: GOOGLE_OFFSITE_DATA_STATE_UNSPECIFIED description: "GoogleOffsiteDataState describes how fresh the performance data for an entity\nis, or why metrics are\ \ unavailable for a given response.\n\n - GOOGLE_OFFSITE_DATA_STATE_FRESH: Imported on the normal daily schedule.\n\ \ - GOOGLE_OFFSITE_DATA_STATE_STALE: Has not refreshed for longer than expected (the daily export stalled).\n - GOOGLE_OFFSITE_DATA_STATE_NO_DATA:\ \ Nothing has imported yet (e.g. a brand-new campaign before the next export).\n - GOOGLE_OFFSITE_DATA_STATE_UNAVAILABLE:\ \ Reserved for a future per-request live-read failure; not emitted in M1\n(reporting is performance-only, so there\ \ is no live read that can fail)." publicGoogleOffsiteFreshness: type: object properties: data_state: $ref: '#/components/schemas/publicGoogleOffsiteDataState' last_pulled_at: type: string format: date-time description: When the daily export last imported this entity. Unset when no data has imported yet. description: GoogleOffsiteFreshness reports the freshness of an entity's performance data. additionalProperties: true publicIdentifyLoginMethodResponse: type: object properties: login_method: $ref: '#/components/schemas/IdentifyLoginMethodResponseLoginMethod' redirect_url: type: string description: URL to redirect the user when the login method is SAML_SSO. description: Response containing the identified login method. required: - login_method additionalProperties: true publicItemSearchRequestOrderBy: type: object properties: column: $ref: '#/components/schemas/rmpcommonOrderByColumn' direction: $ref: '#/components/schemas/commonOrderByDirection' additionalProperties: true publicItemSearchResponse: type: object properties: rows: type: array items: $ref: '#/components/schemas/v1ItemSearchResultRow' description: Rows of items search result. num_counts: type: integer format: int32 description: Number of counts description: ItemSearch response required: - rows - num_counts additionalProperties: true publicListAdAccountUsersResponse: type: object properties: users: type: array items: $ref: '#/components/schemas/v1AdAccountUser' description: List of ad account user information. description: ListAdAccountUsers response required: - users additionalProperties: true publicListAdAccountsResponse: type: object properties: ad_accounts: type: array items: $ref: '#/components/schemas/managementv1AdAccount' description: List of AdAccount infos. description: ListAdAccounts response. required: - ad_accounts additionalProperties: true publicListAdManagerAccountUsersResponse: type: object properties: users: type: array items: $ref: '#/components/schemas/v1AdManagerAccountUser' description: List of AdManagerAccount Users. description: ListAdManagerAccountUsers response. required: - users additionalProperties: true publicListAdManagerAccountsResponse: type: object properties: ad_manager_accounts: type: array items: $ref: '#/components/schemas/v1AdManagerAccount' description: List of AdManagerAccount info. description: ListAdManagerAccounts response. required: - ad_manager_accounts additionalProperties: true publicListAssetCampaignsResponse: type: object properties: campaigns: type: array items: $ref: '#/components/schemas/v1Campaign' description: Asset campaign list. description: ListAssetCampaigns response. required: - campaigns additionalProperties: true publicListCampaignRecommendationsResponse: type: object properties: campaign_recommendations: type: array items: $ref: '#/components/schemas/v1CampaignRecommendation' description: ListCampaignRecommendations response. additionalProperties: true publicListCampaignReviewsResponse: type: object properties: campaign_reviews: type: array items: $ref: '#/components/schemas/v1CampaignReview' description: Campaign reviews information. description: ListCampaignReviews response. required: - campaign_reviews additionalProperties: true publicListCampaignedCreativesResponse: type: object properties: campaigned_creatives: type: array items: $ref: '#/components/schemas/v1CampaignedCreative' description: List of campaigned creatives. description: ListCampaignedCreatives response. required: - campaigned_creatives additionalProperties: true publicListCampaignsResponse: type: object properties: campaigns: type: array items: $ref: '#/components/schemas/v1Campaign' description: List of campaign infos. without_catalog_item_ids: type: boolean description: Flag field that indicates whether campaigns are responded without catalog item ids or not. description: ListCampaigns response. required: - campaigns additionalProperties: true publicListCreativesResponse: type: object properties: creatives: type: array items: $ref: '#/components/schemas/v1Creative' description: List of creatives. description: ListCreatives response. required: - creatives additionalProperties: true publicListCreditsResponse: type: object properties: credits: type: array items: $ref: '#/components/schemas/v1Credit' description: List of Credits info. description: ListCredits Response. required: - credits additionalProperties: true publicListExperimentalFeaturesResponse: type: object properties: features: type: array items: $ref: '#/components/schemas/ListExperimentalFeaturesResponseExperimentalFeature' description: Experimental features enabled for the ad account. description: ListExperimentalFeatures response. required: - features additionalProperties: true publicListImageAssetsResponse: type: object properties: image_assets: type: array items: $ref: '#/components/schemas/v1ImageAsset' description: Image assets information. description: ListImageAssets response. required: - image_assets additionalProperties: true publicListInventoriesRequestAdTypeQueryOption: type: string enum: - ALL_AD_TYPES - ITEM - CREATIVE - BRAND_ITEM - BRAND default: ALL_AD_TYPES description: "AdTypeQueryOption enumerates all types of query option according to ad type.\n\n - ALL_AD_TYPES: If query\ \ option is not provided, all ad types will be listed.\n - ITEM: The query option that list item type.\n - CREATIVE:\ \ The query option that list creative type.\n - BRAND_ITEM: The query option that list brand item type.\n - BRAND:\ \ The query option that list brand type." publicListInventoriesRequestDecisionTypeQueryOption: type: string enum: - ALL - RECOMMENDATION - AUCTION - CREATIVE_AUCTION default: ALL description: "DecisionTypeQueryOption enumerates all types of query option according to inventory's decision type.\n\ \n - ALL: If query option is not provided, all types of inventories will be listed.\n - RECOMMENDATION: The query\ \ option that list recommendation type inventories.\n - AUCTION: The query option that list auction type inventories.\n\ \ - CREATIVE_AUCTION: The query option that list creative auction type inventories." publicListInventoriesResponse: type: object properties: inventories: type: array items: $ref: '#/components/schemas/managementv1Inventory' description: ListInventories response. required: - inventories additionalProperties: true publicListInventoriesV2RequestAdTypeQueryOption: type: string enum: - ALL_AD_TYPES - ITEM - CREATIVE - BRAND_ITEM - BRAND default: ALL_AD_TYPES description: "AdTypeQueryOption enumerates all types of query option according to ad type.\n\n - ALL_AD_TYPES: If query\ \ option is not provided, all ad types will be listed.\n - ITEM: The query option that list item type.\n - CREATIVE:\ \ The query option that list creative type.\n - BRAND_ITEM: The query option that list brand item type.\n - BRAND:\ \ The query option that list brand type." publicListInventoriesV2RequestDecisionTypeQueryOption: type: string enum: - ALL - RECOMMENDATION - AUCTION - CREATIVE_AUCTION default: ALL description: "DecisionTypeQueryOption enumerates all types of query option according to inventory's decision type.\n\ \n - ALL: If query option is not provided, all types of inventories will be listed.\n - RECOMMENDATION: The query\ \ option that list recommendation type inventories.\n - AUCTION: The query option that list auction type inventories.\n\ \ - CREATIVE_AUCTION: The query option that list creative auction type inventories." publicListInventoriesV2Response: type: object properties: inventories: type: array items: $ref: '#/components/schemas/managementv1Inventory' description: ListInventoriesV2 response. required: - inventories additionalProperties: true publicListLandingUrlsResponse: type: object properties: landing_urls: type: array items: $ref: '#/components/schemas/v1LandingUrl' description: List of landing urls. description: ListLandingUrls response. required: - landing_urls additionalProperties: true publicListLineItemDailyReportResponse: type: object properties: rows: type: array items: $ref: '#/components/schemas/v1LineItemDailyReportRow' description: List of daily report rows. description: ListLineItemDailyReports response containing daily report rows. required: - rows additionalProperties: true publicListManagedDashboardOverviewsResponse: type: object properties: managed_dashboard_resources: type: array items: $ref: '#/components/schemas/ListManagedDashboardOverviewsResponseManagedDashboardResource' required: - managed_dashboard_resources additionalProperties: true publicListOffsiteCampaignsResponse: type: object properties: offsite_campaigns: type: array items: $ref: '#/components/schemas/v1OffsiteCampaign' description: OffsiteCampaigns on this page. prev_cursor: type: string description: Cursor for the previous page. Omitted if this is the first page. next_cursor: type: string description: Cursor for the next page. Omitted if this is the last page. total_count: type: integer format: int64 description: Total number of OffsiteCampaigns matching the query. required: - offsite_campaigns additionalProperties: true publicListPlatformAPIKeysResponse: type: object properties: api_keys: type: array items: $ref: '#/components/schemas/PlatformOwnerConfigAPIKey' description: API key info. description: ListPlatformAPIKeys response required: - api_keys additionalProperties: true publicListReservedDisplayInventoriesResponse: type: object properties: inventories: type: array items: $ref: '#/components/schemas/ListReservedDisplayInventoriesResponseReservedDisplayInventory' description: List of reserved display inventories. description: ListReservedDisplayInventories response. required: - inventories additionalProperties: true publicListSellerCurrenciesResponse: type: object properties: currencies: type: array items: type: string description: Distinct seller currency codes (e.g. USD, KRW) from active, non-blocked catalog items. description: Response containing distinct seller currencies found in the catalog. required: - currencies additionalProperties: true publicListSellersResponse: type: object properties: sellers: type: array items: $ref: '#/components/schemas/v1Seller' description: Seller information. description: ListSellers response. required: - sellers additionalProperties: true publicListSpendCapDetailOverviewRequestQueryFilter: type: object properties: group_filters: type: array items: $ref: '#/components/schemas/publicListSpendCapDetailOverviewRequestQueryFilterGroupFilter' logical_operator: $ref: '#/components/schemas/publicListSpendCapDetailOverviewRequestQueryFilterLogicalOperator' additionalProperties: true publicListSpendCapDetailOverviewRequestQueryFilterGroupFilter: type: object properties: filters: type: array items: $ref: '#/components/schemas/publicListSpendCapDetailOverviewRequestQueryFilterSingleFilter' logical_operator: $ref: '#/components/schemas/publicListSpendCapDetailOverviewRequestQueryFilterGroupFilterLogicalOperator' additionalProperties: true publicListSpendCapDetailOverviewRequestQueryFilterGroupFilterLogicalOperator: type: string enum: - OR default: OR publicListSpendCapDetailOverviewRequestQueryFilterLogicalOperator: type: string enum: - AND default: AND publicListSpendCapDetailOverviewRequestQueryFilterSingleFilter: type: object properties: column: $ref: '#/components/schemas/publicListSpendCapDetailOverviewRequestQueryFilterSingleFilterFilterColumn' filter_operator: $ref: '#/components/schemas/publicListSpendCapDetailOverviewRequestQueryFilterSingleFilterFilterOperator' status: $ref: '#/components/schemas/publicListSpendCapDetailOverviewRequestQueryFilterSingleFilterSpendCapStatusFilterValue' period: $ref: '#/components/schemas/SingleFilterSpendCapPeriodFilterValue' additionalProperties: true publicListSpendCapDetailOverviewRequestQueryFilterSingleFilterFilterColumn: type: string enum: - UNKNOWN_FILTER_COLUMN - STATUS - PERIOD default: UNKNOWN_FILTER_COLUMN publicListSpendCapDetailOverviewRequestQueryFilterSingleFilterFilterOperator: type: string enum: - UNKNOWN_FILTER_OPERATOR - EQ default: UNKNOWN_FILTER_OPERATOR publicListSpendCapDetailOverviewRequestQueryFilterSingleFilterSpendCapStatusFilterValue: type: string enum: - UNKNOWN_SPEND_CAP_STATUS_FILTER_VALUE - SCHEDULED - INACTIVE - ACTIVE - ENDED - DEPLETED - ERROR default: UNKNOWN_SPEND_CAP_STATUS_FILTER_VALUE publicListSpendCapDetailOverviewResponse: type: object properties: spend_cap_detail_overviews: type: array items: $ref: '#/components/schemas/ListSpendCapDetailOverviewResponseSpendCapDetailOverview' description: List of spend cap detail overview. total: type: integer format: int64 description: Total number of spend cap detail overviews. prev_cursor: type: string description: Cursor for fetching previous list. next_cursor: type: string description: Cursor for fetching next list. search_value: type: string description: 'Search keyword: Spend Cap title' additionalProperties: true publicListSpendCapsResponse: type: object properties: spend_caps: type: array items: $ref: '#/components/schemas/v1SpendCap' description: List of spend caps. additionalProperties: true publicListSpendingLimitsResponse: type: object properties: spending_limits: type: array items: $ref: '#/components/schemas/v1SpendingLimit' description: List of spending limits. description: ListSpendingLimits response. required: - spending_limits additionalProperties: true publicListTrustedDevicesResponse: type: object properties: trusted_devices: type: array items: $ref: '#/components/schemas/publicTrustedDevice' description: List of trusted devices for the user. description: ListTrustedDevices response. required: - trusted_devices additionalProperties: true publicListUserJoinRequestsResponse: type: object properties: user_join_requests: type: array items: $ref: '#/components/schemas/v1UserJoinRequest' description: UserJoinRequest information. description: ListUserJoinRequests response. required: - user_join_requests additionalProperties: true publicListUsersResponse: type: object properties: users: type: array items: $ref: '#/components/schemas/v1User' description: List of user information. description: ListUsers response required: - users additionalProperties: true publicListVideoAssetsResponse: type: object properties: video_assets: type: array items: $ref: '#/components/schemas/v1VideoAsset' description: Video assets information. description: ListVideoAssets response. required: - video_assets additionalProperties: true publicListWalletsResponse: type: object properties: wallets: type: array items: $ref: '#/components/schemas/v1Wallet' description: List of Wallets. description: ListWallets response. required: - wallets additionalProperties: true publicListWebhookEndpointsResponse: type: object properties: webhook_endpoints: type: array items: $ref: '#/components/schemas/v1WebhookEndpoint' description: List of webhook endpoints. description: ListWebhookEndpoints response. required: - webhook_endpoints additionalProperties: true publicListWebhookSigningKeysResponse: type: object properties: signing_keys: type: array items: $ref: '#/components/schemas/v1WebhookSigningKey' description: List of ACTIVE signing keys for the endpoint. description: ListWebhookSigningKeys response. required: - signing_keys additionalProperties: true publicLogoutResponse: type: object description: Logout response. additionalProperties: true publicNotifyUserJoinRequestResponse: type: object additionalProperties: true publicOffsiteAdAccountResource: type: object properties: ad_account_id: type: string description: AdAccount id. ad_account_title: type: string description: AdAccount title. ad_account_state: $ref: '#/components/schemas/v1AdAccountStateInfoAdAccountState' metric: $ref: '#/components/schemas/publicOffsiteReportMetric' freshness: $ref: '#/components/schemas/publicGoogleOffsiteFreshness' currency: type: string description: ISO-4217 currency of the money values in metric. timezone: type: string description: IANA timezone the metric's dates are normalized to. description: OffsiteAdAccountResource is one ad-account (seller) row on the platform page. additionalProperties: true publicOffsiteAttributionMicro: type: object properties: platform: type: string format: int64 description: Platform-view value in micros. Reserved; unset in M1. advertiser: type: string format: int64 description: Advertiser-view value in micros. description: 'OffsiteAttributionMicro carries a money value (micros) that can be split by attribution view. M1 populates advertiser only; platform is reserved for when the platform attribution view ships.' additionalProperties: true publicOffsiteAttributionRatio: type: object properties: platform: type: number format: double description: Platform-view ratio (sales / spend). Reserved; unset in M1. advertiser: type: number format: double description: Advertiser-view ratio (sales / spend). description: 'OffsiteAttributionRatio carries a ratio (e.g. ROAS) that can be split by attribution view. M1 populates advertiser only.' additionalProperties: true publicOffsiteCampaignResource: type: object properties: offsite_campaign_id: type: string description: OffsiteCampaign id. title: type: string description: Campaign title. enabling_state: $ref: '#/components/schemas/OffsiteCampaignEnablingState' metric: $ref: '#/components/schemas/publicOffsiteReportMetric' freshness: $ref: '#/components/schemas/publicGoogleOffsiteFreshness' currency: type: string description: ISO-4217 currency of the money values in metric. timezone: type: string description: IANA timezone the metric's dates are normalized to. description: OffsiteCampaignResource is one campaign row on the ad-account page. additionalProperties: true publicOffsiteReportMetric: type: object properties: money_spent: type: string format: int64 description: Spend in micros (sum of Google's metrics_cost_micros). revenue: $ref: '#/components/schemas/publicOffsiteAttributionMicro' imp_count: type: string format: int64 description: Impression count. click_count: type: string format: int64 description: Click count. ctr: type: number format: double description: Click-through rate (clicks / impressions). purchase_count: type: string format: int64 description: 'Purchases (shown as ''Purchases''). From Google''s metrics_conversions: the raw fractional values are summed and rounded once at the total.' roas: $ref: '#/components/schemas/publicOffsiteAttributionRatio' cpc: type: number format: double description: Cost per click in micros. Unset when there are no clicks. description: 'OffsiteReportMetric is one aggregated set of performance metrics over a date range. Field names follow the onsite report types so the FE can reuse its existing column code. In M1 each metric is a single value (advertiser view).' additionalProperties: true publicOffsiteReportRow: type: object properties: date: type: string description: Date in 'YYYY-MM-DD', in the normalized timezone. Populated when group_by includes DATE. timezone: type: string description: IANA timezone the dates are normalized to. currency: type: string description: ISO-4217 currency of the money values. M1 is single-currency per retailer. ad_account_id: type: string description: 'Ad account id. Reserved: summary RPCs group only by DATE/CURRENCY; per-ad-account rows come from QueryOffsiteAdAccountResources.' ad_account_title: type: string description: Ad account title. Reserved (not populated by summary RPCs). ad_manager_account_id: type: string description: 'Ad Manager Account id. Reserved: per-AMA rows come from QueryOffsiteAdManagerAccountResources.' ad_manager_account_title: type: string description: Ad Manager Account title. Reserved (not populated by summary RPCs). offsite_campaign_id: type: string description: 'OffsiteCampaign id. Reserved: per-campaign rows come from QueryOffsiteCampaignResources.' campaign_title: type: string description: Campaign title. Reserved (not populated by summary RPCs). metric: $ref: '#/components/schemas/publicOffsiteReportMetric' freshness: $ref: '#/components/schemas/publicGoogleOffsiteFreshness' description: 'OffsiteReportRow is one aggregated reporting row. Which dimension fields are populated depends on the request''s group_by (mirrors the onsite PlatformSummaryRow model): the summary cards use group_by=[CURRENCY] (one row), and the trend chart uses group_by=[DATE, CURRENCY] (one row per day per currency — one per day in single-currency M1). Per-entity rows for the tables come from the paginated QueryOffsite*Resources RPCs instead.' additionalProperties: true publicOffsiteReportSummaryGroupByColumn: type: string enum: - UNKNOWN_GROUP_BY - DATE - CURRENCY - AD_ACCOUNT - AD_MANAGER_ACCOUNT default: UNKNOWN_GROUP_BY description: 'Dimensions a summary query can group rows by. A summary serves the bounded chart and the post-aggregated breakdown rows: the cards use [CURRENCY] (one row) and the trend chart uses [DATE] (one row per day). AD_MANAGER_ACCOUNT (platform summary only) post-aggregates the platform''s sellers into one row per (AMA, currency) — the AMAs tab. AD_ACCOUNT (AMA-owner summary only) breaks the AMA''s total into one row per (ad account, currency). The cursor-paginated *Resources RPCs serve the per-entity tables.' publicOffsiteReportSummaryOrderByColumn: type: string enum: - UNKNOWN_ORDER_BY - TIME_DATE - TIME_DATE_DESC - MONEY_SPENT - MONEY_SPENT_DESC default: UNKNOWN_ORDER_BY description: 'Columns a summary query can order rows by. The chart only ever orders by day (trend) or spend (cards), so only the time and spend columns are offered; title ordering belongs to the cursor-paginated *Resources RPCs.' publicOffsiteResourceSorter: type: object properties: sorts: type: array items: $ref: '#/components/schemas/OffsiteResourceSorterSingleSort' description: Sort keys applied in order; the server appends an id tiebreaker for a stable total order. description: 'OffsiteResourceSorter is the shared sort spec for the three offsite reporting *Resources tables (QueryOffsiteAdAccountResources / QueryOffsitePlatformResources / QueryOffsiteAdManagerAccountResources). They share the same per-row metric shape, so one sorter type covers all three. Multi-column: the sorts apply in the listed order and the server appends a deterministic id tiebreaker. An empty sorter uses the server default (most recent first).' additionalProperties: true publicOverwriteInventoryAccessBulkRequestAdAccountAccessUpdate: type: object properties: ad_account_id: type: string description: Identifier of the ad accounts. access: $ref: '#/components/schemas/publicOverwriteInventoryAccessBulkRequestAdAccountAccessUpdateAccess' required: - ad_account_id - access additionalProperties: true publicOverwriteInventoryAccessBulkRequestAdAccountAccessUpdateAccess: type: string enum: - UNKNOWN - ACCESSIBLE default: UNKNOWN publicOverwriteInventoryAccessBulkRequestLabelValueAccessUpdate: type: object properties: label_value_id: type: string description: Identifier of the label value. access: $ref: '#/components/schemas/publicOverwriteInventoryAccessBulkRequestLabelValueAccessUpdateAccess' required: - label_value_id - access additionalProperties: true publicOverwriteInventoryAccessBulkRequestLabelValueAccessUpdateAccess: type: string enum: - UNKNOWN - ACCESSIBLE default: UNKNOWN publicOverwriteInventoryAccessBulkResponse: type: object additionalProperties: true publicOverwriteLabelValueAdAccountRelationshipBulkResponse: type: object additionalProperties: true publicOverwritePredefinedAudienceAccessBulkRequestAdAccountAccessUpdate: type: object properties: ad_account_id: type: string description: Identifier of the ad accounts. access: $ref: '#/components/schemas/publicOverwritePredefinedAudienceAccessBulkRequestAdAccountAccessUpdateAccess' required: - ad_account_id - access additionalProperties: true publicOverwritePredefinedAudienceAccessBulkRequestAdAccountAccessUpdateAccess: type: string enum: - UNKNOWN - ACCESSIBLE default: UNKNOWN publicOverwritePredefinedAudienceAccessBulkRequestLabelValueAccessUpdate: type: object properties: label_value_id: type: string description: Identifier of the label value. access: $ref: '#/components/schemas/publicOverwritePredefinedAudienceAccessBulkRequestLabelValueAccessUpdateAccess' required: - label_value_id - access additionalProperties: true publicOverwritePredefinedAudienceAccessBulkRequestLabelValueAccessUpdateAccess: type: string enum: - UNKNOWN - ACCESSIBLE default: UNKNOWN publicOverwritePredefinedAudienceAccessBulkResponse: type: object additionalProperties: true publicOverwritePredefinedAudienceAdAccountAccessBulkRequestUpdate: type: object properties: ad_account_id: type: string description: Identifier of the ad accounts. access: $ref: '#/components/schemas/OverwritePredefinedAudienceAdAccountAccessBulkRequestUpdateAccess' required: - ad_account_id - access additionalProperties: true publicOverwritePredefinedAudienceAdAccountAccessBulkResponse: type: object additionalProperties: true publicQueryAdAccountChangeLogsResponse: type: object properties: rows: type: array items: $ref: '#/components/schemas/v1EntityChangeLog' description: List of AdAccountChangeLogs. page_info: $ref: '#/components/schemas/commonPageInfo' description: QueryAdAccountChangeLogs response. required: - rows - page_info additionalProperties: true publicQueryAdAccountSummaryBulkResponse: type: object properties: rows: type: array items: $ref: '#/components/schemas/v1AdAccountSummaryRow' description: Rows of ad-account-level summarized reporting. description: QueryAdAccountSummaryBulk response required: - rows additionalProperties: true publicQueryAdAccountSummaryResponse: type: object properties: rows: type: array items: $ref: '#/components/schemas/v1AdAccountSummaryRow' description: Rows of ad-account-level summarized reporting. description: QueryAdAccountSummary response required: - rows additionalProperties: true publicQueryAdAccountUserAccessChangeLogsResponse: type: object properties: rows: type: array items: $ref: '#/components/schemas/v1AdAccountUserAccessChangeLog' description: List of AdAccountUserAccessChangeLogs. page_info: $ref: '#/components/schemas/commonPageInfo' description: QueryAdAccountUserAccessChangeLogs response. required: - rows - page_info additionalProperties: true publicQueryAdAccountsAdvertisingPlatformInsightDetailsResponse: type: object properties: ad_accounts: type: array items: $ref: '#/components/schemas/QueryAdAccountsAdvertisingPlatformInsightDetailsResponseAdAccountNotAdvertising' description: List of ad accounts that are not advertising. prev_cursor: type: string description: Cursor for fetching previous page. next_cursor: type: string description: Cursor for fetching next page. total: type: integer format: int64 description: Total number of ad accounts not advertising. last_updated_at: type: string format: date-time description: Timestamp when the platform insights were last updated. next_update_at: type: string format: date-time description: Timestamp when the platform insights will be updated next. required: - ad_accounts - total - last_updated_at - next_update_at additionalProperties: true publicQueryAdAccountsItemAdoptionPlatformInsightDetailsResponse: type: object properties: ad_accounts: type: array items: $ref: '#/components/schemas/QueryAdAccountsItemAdoptionPlatformInsightDetailsResponseAdAccountUnderAdvertisingItem' description: List of ad accounts with under advertising item details. prev_cursor: type: string description: Cursor for fetching previous page. next_cursor: type: string description: Cursor for fetching next page. total: type: integer format: int64 description: Total number of ad accounts with under advertising item details. last_updated_at: type: string format: date-time description: Timestamp when the platform insights were last updated. next_update_at: type: string format: date-time description: Timestamp when the platform insights will be updated next. required: - ad_accounts - total - last_updated_at - next_update_at additionalProperties: true publicQueryAdAccountsResponse: type: object properties: ad_accounts: type: array items: $ref: '#/components/schemas/managementv1AdAccount' description: List of ad account information. description: QueryAdAccounts response. required: - ad_accounts additionalProperties: true publicQueryAdAccountsSpendingLimitPlatformInsightDetailsResponse: type: object properties: ad_accounts: type: array items: $ref: '#/components/schemas/QueryAdAccountsSpendingLimitPlatformInsightDetailsResponseNearingSpendingLimitAdAccount' description: List of ad accounts nearing spending limit details. prev_cursor: type: string description: Cursor for fetching previous page. next_cursor: type: string description: Cursor for fetching next page. total: type: integer format: int64 description: Total number of ad accounts nearing spending limit details. last_updated_at: type: string format: date-time description: Timestamp when the platform insights were last updated. next_update_at: type: string format: date-time description: Timestamp when the platform insights will be updated next. required: - ad_accounts - total - last_updated_at - next_update_at additionalProperties: true publicQueryAdAccountsV2Response: type: object properties: ad_accounts: type: array items: $ref: '#/components/schemas/managementv1AdAccount' description: List of ad accounts prev_cursor: type: string description: Indicator of the page. It will be used for the previous request. If it's the first page, then it will be omitted. next_cursor: type: string description: Indicator of the page. It will be used for the next request. If it's the last page, then it will be omitted. total_count: type: integer format: int64 description: Total number of resources to be returned. This will be the same value within the same query options. required: - ad_accounts additionalProperties: true publicQueryAdAccountsWalletPlatformInsightDetailsResponse: type: object properties: ad_accounts: type: array items: $ref: '#/components/schemas/QueryAdAccountsWalletPlatformInsightDetailsResponseWalletRunningLowAdAccount' description: List of ad accounts with low wallet balance. prev_cursor: type: string description: Cursor for the previous page. Omitted if this is the first page. next_cursor: type: string description: Cursor for the next page. Omitted if this is the last page. total: type: integer format: int64 description: Total number of ad accounts matching the query criteria. last_updated_at: type: string format: date-time description: Timestamp when the platform insights were last updated. next_update_at: type: string format: date-time description: Timestamp when the platform insights will be updated next. required: - ad_accounts - total - last_updated_at - next_update_at additionalProperties: true publicQueryAdAccountsWithInventoryAccessResponse: type: object properties: ad_accounts: type: array items: $ref: '#/components/schemas/publicQueryAdAccountsWithInventoryAccessResponseAdAccountWithAccess' description: List of ad accounts with access info total: type: integer format: int64 description: Total number of ad accounts prev_cursor: type: string description: Cursor for fetching previous list next_cursor: type: string description: Cursor for fetching next list description: QueryAdAccountsWithInventoryAccess response. required: - ad_accounts - total additionalProperties: true publicQueryAdAccountsWithInventoryAccessResponseAdAccountWithAccess: type: object properties: ad_account: $ref: '#/components/schemas/managementv1AdAccount' access: $ref: '#/components/schemas/v1AdAccountAccessType' required: - ad_account - access additionalProperties: true publicQueryAdAccountsWithPredefinedAudienceAccessResponse: type: object properties: ad_accounts: type: array items: $ref: '#/components/schemas/publicQueryAdAccountsWithPredefinedAudienceAccessResponseAdAccountWithAccess' description: List of ad accounts with access info total: type: string format: uint64 description: Total number of ad accounts prev_cursor: type: string description: Cursor for fetching previous list next_cursor: type: string description: Cursor for fetching next list description: QueryAdAccountsWithPredefinedAudienceAccessResponse request. required: - ad_accounts - total additionalProperties: true publicQueryAdAccountsWithPredefinedAudienceAccessResponseAdAccountWithAccess: type: object properties: ad_account: $ref: '#/components/schemas/managementv1AdAccount' access: $ref: '#/components/schemas/v1AudienceAccessType' required: - ad_account - access additionalProperties: true publicQueryAdManagerAccountChangeLogsResponse: type: object properties: rows: type: array items: $ref: '#/components/schemas/v1EntityChangeLog' description: List of ad manager account change logs. page_info: $ref: '#/components/schemas/commonPageInfo' description: QueryAdManagerAccountChangeLogs response. required: - rows - page_info additionalProperties: true publicQueryAdManagerAccountUserAccessChangeLogsResponse: type: object properties: rows: type: array items: $ref: '#/components/schemas/v1AdManagerAccountUserAccessChangeLog' description: List of ad manager account user access change logs. page_info: $ref: '#/components/schemas/commonPageInfo' description: QueryAdManagerAccountUserAccessChangeLogs response. required: - rows - page_info additionalProperties: true publicQueryAdManagerAccountsResponse: type: object properties: ad_manager_accounts: type: array items: $ref: '#/components/schemas/v1AdManagerAccount' description: List of ad manager accounts. prev_cursor: type: string description: Cursor for fetching previous list. next_cursor: type: string description: Cursor for fetching next list. total_count: type: integer format: int64 description: Total number of ad manager accounts matching the same query options. required: - ad_manager_accounts additionalProperties: true publicQueryAssignableAdAccountsWithLabelValueAccessResponse: type: object properties: ad_accounts: type: array items: $ref: '#/components/schemas/publicQueryAssignableAdAccountsWithLabelValueAccessResponseAdAccountWithAccess' description: List of ad accounts with access info total: type: integer format: int64 description: Total number of ad accounts prev_cursor: type: string description: Cursor for fetching previous list next_cursor: type: string description: Cursor for fetching next list description: QueryAdAccountsWithLabelValueAccess response. required: - ad_accounts - total additionalProperties: true publicQueryAssignableAdAccountsWithLabelValueAccessResponseAdAccountWithAccess: type: object properties: ad_account: $ref: '#/components/schemas/managementv1AdAccount' access: $ref: '#/components/schemas/v1LabelValueAccessType' required: - ad_account - access additionalProperties: true publicQueryBrandsRequestQuerySorter: type: object properties: sorters: type: array items: $ref: '#/components/schemas/publicQueryBrandsRequestQuerySorterSingleSorter' description: Query sorter. additionalProperties: true publicQueryBrandsRequestQuerySorterSingleSorter: type: object properties: column: $ref: '#/components/schemas/publicQueryBrandsRequestQuerySorterSingleSorterSorterColumn' sorter_operator: $ref: '#/components/schemas/publicQueryBrandsRequestQuerySorterSingleSorterSorterOperator' additionalProperties: true publicQueryBrandsRequestQuerySorterSingleSorterSorterColumn: type: string enum: - UNKNOWN_SORTER_COLUMN - BRAND - APPEARANCES default: UNKNOWN_SORTER_COLUMN publicQueryBrandsRequestQuerySorterSingleSorterSorterOperator: type: string enum: - UNKNOWN_SORTER_OPERATOR - ASC - DESC default: UNKNOWN_SORTER_OPERATOR publicQueryBrandsResponse: type: object properties: brands: type: array items: $ref: '#/components/schemas/v1BrandContent' description: Brand contents. next_cursor: type: string description: Next cursor for pagination. required: - brands additionalProperties: true publicQueryCampaignChangeLogItemsResponse: type: object properties: rows: type: array items: $ref: '#/components/schemas/v1CampaignChangeLogItem' description: List of campaigned item history. page_info: $ref: '#/components/schemas/commonPageInfo' description: Response message of QueryCampaignItemsHistory. required: - rows - page_info additionalProperties: true publicQueryCampaignChangeLogsResponse: type: object properties: rows: type: array items: $ref: '#/components/schemas/v1CampaignEntityChangeLog' description: List of campaign history. page_info: $ref: '#/components/schemas/commonPageInfo' description: Response message of QueryCampaignChangeHistory. required: - rows - page_info additionalProperties: true publicQueryCampaignHomeResourcesResponse: type: object properties: rows: type: array items: $ref: '#/components/schemas/v1CampaignHomeResourceRow' description: Rows of summarized reporting. description: QueryCampaignHomeResources response required: - rows additionalProperties: true publicQueryCampaignHomeResourcesV2RequestQueryFilter: type: object properties: filters: type: array items: $ref: '#/components/schemas/publicQueryCampaignHomeResourcesV2RequestQueryFilterSingleFilter' logical_operator: $ref: '#/components/schemas/publicQueryCampaignHomeResourcesV2RequestQueryFilterLogicalOperator' additionalProperties: true publicQueryCampaignHomeResourcesV2RequestQueryFilterLogicalOperator: type: string enum: - OR default: OR publicQueryCampaignHomeResourcesV2RequestQueryFilterSingleFilter: type: object properties: column: $ref: '#/components/schemas/publicQueryCampaignHomeResourcesV2RequestQueryFilterSingleFilterFilterColumn' filter_operator: $ref: '#/components/schemas/publicQueryCampaignHomeResourcesV2RequestQueryFilterSingleFilterFilterOperator' value: $ref: '#/components/schemas/publicQueryCampaignHomeResourcesV2RequestQueryFilterSingleFilterFilterValue' additionalProperties: true publicQueryCampaignHomeResourcesV2RequestQueryFilterSingleFilterFilterColumn: type: string enum: - UNKNOWN_FILTER_COLUMN - LISTING_STATUS default: UNKNOWN_FILTER_COLUMN publicQueryCampaignHomeResourcesV2RequestQueryFilterSingleFilterFilterOperator: type: string enum: - UNKNOWN_FILTER_OPERATOR - EQ default: UNKNOWN_FILTER_OPERATOR publicQueryCampaignHomeResourcesV2RequestQueryFilterSingleFilterFilterValue: type: string enum: - UNKNOWN_FILTER_VALUE - LISTED - NOT_LISTED default: UNKNOWN_FILTER_VALUE publicQueryCampaignHomeResourcesV2RequestQuerySorter: type: object properties: sorters: type: array items: $ref: '#/components/schemas/publicQueryCampaignHomeResourcesV2RequestQuerySorterSingleSorter' additionalProperties: true publicQueryCampaignHomeResourcesV2RequestQuerySorterSingleSorter: type: object properties: column: $ref: '#/components/schemas/publicQueryCampaignHomeResourcesV2RequestQuerySorterSingleSorterSorterColumn' sorter_operator: $ref: '#/components/schemas/publicQueryCampaignHomeResourcesV2RequestQuerySorterSingleSorterSorterOperator' additionalProperties: true publicQueryCampaignHomeResourcesV2RequestQuerySorterSingleSorterSorterColumn: type: string enum: - UNKNOWN_SORTER_COLUMN - ITEM_ID - ITEM_TITLE - LISTING_STATUS - IMPRESSIONS - CLICKS - CTR - AD_SPEND - CPM - CPC - TOTAL_PURCHASE - DIRECT_PURCHASE - INDIRECT_PURCHASE - TOTAL_SALES - DIRECT_SALES - INDIRECT_SALES - TOTAL_ROAS - DIRECT_ROAS - INDIRECT_ROAS - CR - TOTAL_ACOS - DIRECT_ACOS - INDIRECT_ACOS default: UNKNOWN_SORTER_COLUMN publicQueryCampaignHomeResourcesV2RequestQuerySorterSingleSorterSorterOperator: type: string enum: - UNKNOWN_SORTER_OPERATOR - ASC - DESC default: UNKNOWN_SORTER_OPERATOR publicQueryCampaignHomeResourcesV2Response: type: object properties: campaign_home_resources: type: array items: $ref: '#/components/schemas/v1CampaignHomeResource' description: List of campaign home resources prev_cursor: type: string description: Indicator of the page. It will be used for the previous request. If it's the first page, then it will be omitted. next_cursor: type: string description: Indicator of the page. It will be used for the next request. If it's the last page, then it will be omitted. total_count: type: integer format: int64 description: Total number of resources to be returned. This will be the same value within the same query options. description: QueryCampaignHomeResourcesV2 response required: - campaign_home_resources additionalProperties: true publicQueryCampaignReviewQueueRequestOrderBy: type: object properties: column: $ref: '#/components/schemas/publicQueryCampaignReviewQueueRequestOrderByColumn' direction: $ref: '#/components/schemas/commonOrderByDirection' additionalProperties: true publicQueryCampaignReviewQueueRequestOrderByColumn: type: string enum: - UNKNOWN_ORDER_BY_COLUMN - CAMPAIGN_ID default: UNKNOWN_ORDER_BY_COLUMN publicQueryCampaignReviewQueueResponse: type: object properties: rows: type: array items: $ref: '#/components/schemas/v1CampaignReviewQueueRow' description: Campaign rows for the current page. prev_cursor: type: string description: Cursor for the previous page. Omitted on the first page. next_cursor: type: string description: Cursor for the next page. Omitted on the last page. total_count: type: integer format: int64 description: Total matching campaigns. Computed on the first page and cached in the cursor. description: QueryCampaignReviewQueue response. required: - rows - total_count additionalProperties: true publicQueryCampaignSpendCapAssignmentsResponse: type: object properties: assignments: type: array items: $ref: '#/components/schemas/v1CampaignSpendCapAssignment' description: Spend cap assignments applied to the campaign. prev_cursor: type: string description: Cursor for fetching previous list. next_cursor: type: string description: Cursor for fetching next list. total_count: type: integer format: int64 description: Total number of assignments matching the same query options. additionalProperties: true publicQueryCampaignsBidPlatformInsightDetailsResponse: type: object properties: campaigns: type: array items: $ref: '#/components/schemas/publicQueryCampaignsBidPlatformInsightDetailsResponseCampaignLowBid' description: List of campaigns with low bid details. prev_cursor: type: string description: Cursor for fetching previous page. next_cursor: type: string description: Cursor for fetching next page. total: type: integer format: int64 description: Total number of campaigns with low bid details. last_updated_at: type: string format: date-time description: Timestamp when the platform insights were last updated. next_update_at: type: string format: date-time description: Timestamp when the platform insights will be updated next. required: - campaigns - total - last_updated_at - next_update_at additionalProperties: true publicQueryCampaignsBidPlatformInsightDetailsResponseCampaignLowBid: type: object properties: id: type: string description: Unique identifier of the campaign. title: type: string description: Title of the campaign. ad_account_id: type: string description: Unique identifier of the ad account. ad_account_title: type: string description: Title of the ad account. budget: $ref: '#/components/schemas/rmpcommonBudget' budget_utilization: type: number format: double description: Percentage of budget utilization for the campaign. target_cpc: $ref: '#/components/schemas/rmpcommonMoneyMicro' target_cpm: $ref: '#/components/schemas/rmpcommonMoneyMicro' suggested_bid: $ref: '#/components/schemas/rmpcommonMoneyMicro' required: - budget - suggested_bid additionalProperties: true publicQueryCampaignsBudgetPlatformInsightDetailsResponse: type: object properties: campaigns: type: array items: $ref: '#/components/schemas/publicQueryCampaignsBudgetPlatformInsightDetailsResponseCampaignLowBudget' description: List of campaigns with low budget details. prev_cursor: type: string description: Cursor for fetching previous page. next_cursor: type: string description: Cursor for fetching next page. total: type: integer format: int64 description: Total number of campaigns with low budget details. last_updated_at: type: string format: date-time description: Timestamp when the platform insights were last updated. next_update_at: type: string format: date-time description: Timestamp when the platform insights will be updated next. required: - campaigns - total - last_updated_at - next_update_at additionalProperties: true publicQueryCampaignsBudgetPlatformInsightDetailsResponseCampaignLowBudget: type: object properties: id: type: string description: Unique identifier of the campaign. title: type: string description: Title of the campaign. ad_account_id: type: string description: Unique identifier of the ad account. ad_account_title: type: string description: Title of the ad account. ad_spend: $ref: '#/components/schemas/rmpcommonMoneyMicro' budget: $ref: '#/components/schemas/rmpcommonBudget' missed_impressions_count: type: string format: uint64 description: Number of missed impressions due to budget constraints. required: - ad_spend - budget additionalProperties: true publicQueryCampaignsExpirationPlatformInsightDetailsResponse: type: object properties: campaigns: type: array items: $ref: '#/components/schemas/QueryCampaignsExpirationPlatformInsightDetailsResponseCampaignExpiringSoon' description: List of campaigns that are expiring soon. prev_cursor: type: string description: Cursor for fetching previous page. next_cursor: type: string description: Cursor for fetching next page. total: type: integer format: int64 description: Total number of campaigns that are expiring soon. last_updated_at: type: string format: date-time description: Timestamp when the platform insights were last updated. next_update_at: type: string format: date-time description: Timestamp when the platform insights will be updated next. required: - campaigns - total - last_updated_at - next_update_at additionalProperties: true publicQueryCampaignsRoasPlatformInsightDetailsResponse: type: object properties: campaigns: type: array items: $ref: '#/components/schemas/publicQueryCampaignsRoasPlatformInsightDetailsResponseCampaignHighTargetRoas' description: List of campaigns with high target ROAS details. prev_cursor: type: string description: Cursor for fetching previous page. next_cursor: type: string description: Cursor for fetching next page. total: type: integer format: int64 description: Total number of campaigns with high target ROAS details. last_updated_at: type: string format: date-time description: Timestamp when the platform insights were last updated. next_update_at: type: string format: date-time description: Timestamp when the platform insights will be updated next. required: - campaigns - total - last_updated_at - next_update_at additionalProperties: true publicQueryCampaignsRoasPlatformInsightDetailsResponseCampaignHighTargetRoas: type: object properties: id: type: string description: Unique identifier of the campaign. title: type: string description: Title of the campaign. ad_account_id: type: string description: Unique identifier of the ad account. ad_account_title: type: string description: Title of the ad account. budget: $ref: '#/components/schemas/rmpcommonBudget' budget_utilization: type: number format: double description: Percentage of budget utilization for the campaign. target_roas: type: integer format: int64 description: Current target ROAS (Return on Ad Spend) for the campaign. suggested_target_roas: type: integer format: int64 description: Suggested target ROAS for the campaign. required: - budget additionalProperties: true publicQueryCatalogHistoryResponse: type: object properties: history: type: array items: $ref: '#/components/schemas/v1CatalogHistory' description: List of catalog history entries. prev_cursor: type: string description: Cursor for previous page. next_cursor: type: string description: Cursor for next page. total: type: integer format: int64 description: Total number of catalog history entries. additionalProperties: true publicQueryCatalogItemsByPlatformResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/v1CatalogItem' description: Catalog items on the current page. prev_cursor: type: string description: Cursor for the previous page. Absent on the first page. next_cursor: type: string description: Cursor for the next page. Absent on the last page. additionalProperties: true publicQueryCategoriesRequestQuerySorter: type: object properties: sorters: type: array items: $ref: '#/components/schemas/publicQueryCategoriesRequestQuerySorterSingleSorter' description: Query sorter. additionalProperties: true publicQueryCategoriesRequestQuerySorterSingleSorter: type: object properties: column: $ref: '#/components/schemas/publicQueryCategoriesRequestQuerySorterSingleSorterSorterColumn' sorter_operator: $ref: '#/components/schemas/publicQueryCategoriesRequestQuerySorterSingleSorterSorterOperator' additionalProperties: true publicQueryCategoriesRequestQuerySorterSingleSorterSorterColumn: type: string enum: - UNKNOWN_SORTER_COLUMN - CATEGORY - APPEARANCES default: UNKNOWN_SORTER_COLUMN publicQueryCategoriesRequestQuerySorterSingleSorterSorterOperator: type: string enum: - UNKNOWN_SORTER_OPERATOR - ASC - DESC default: UNKNOWN_SORTER_OPERATOR publicQueryCategoriesResponse: type: object properties: categories: type: array items: $ref: '#/components/schemas/v1CategoryContent' description: Category contents. next_cursor: type: string description: Next cursor for pagination. required: - categories additionalProperties: true publicQueryCategorySubtreeResponse: type: object properties: category: $ref: '#/components/schemas/v1CategoryNode' next_cursor: type: string description: Next cursor for pagination. revision: type: string description: Revision of the category. required: - category - revision additionalProperties: true publicQueryCreativeChangeLogsResponse: type: object properties: rows: type: array items: $ref: '#/components/schemas/v1EntityChangeLog' description: List of creative change logs. page_info: $ref: '#/components/schemas/commonPageInfo' description: QueryCreativeChangeLogs response. required: - rows - page_info additionalProperties: true publicQueryCreativeOverviewsResponse: type: object properties: creative_overviews: type: array items: $ref: '#/components/schemas/v1CreativeOverview' description: List of creative overviews. description: QueryCreativeOverviews response. required: - creative_overviews additionalProperties: true publicQueryCreativesResponse: type: object properties: creatives: type: array items: $ref: '#/components/schemas/v1Creative' description: List of creatives. description: QueryCreatives response. required: - creatives additionalProperties: true publicQueryCreditHistoryResponse: type: object properties: rows: type: array items: $ref: '#/components/schemas/v1CreditAccountHistoryLog' description: List of WalletAccountHistoryLogs. page_info: $ref: '#/components/schemas/commonPageInfo' description: QueryCreditHistory response. required: - rows - page_info additionalProperties: true publicQueryCreditsResponse: type: object properties: result: type: object additionalProperties: $ref: '#/components/schemas/publicCredits' description: Map of credits keyed by an ad account id. description: QueryCreditsResponse Response. required: - result additionalProperties: true publicQueryCustomTargetDailySummaryResponse: type: object properties: rows: type: array items: $ref: '#/components/schemas/v1LineItemDailyCustomReportRow' description: List of daily report rows. description: QueryCustomTargetDailySummary response containing daily report rows. required: - rows additionalProperties: true publicQueryCustomTargetKeysBFFResponse: type: object properties: custom_target_keys: type: array items: $ref: '#/components/schemas/v1CustomTargetKey' description: List of custom target keys matching the query criteria. prev_cursor: type: string description: Cursor for the previous page. Omitted if this is the first page. next_cursor: type: string description: Cursor for the next page. Omitted if this is the last page. total: type: integer format: int64 description: Total number of custom target keys matching the query criteria. description: QueryCustomTargetKeys response. required: - custom_target_keys - total additionalProperties: true publicQueryCustomTargetKeysResponse: type: object properties: custom_target_keys: type: array items: $ref: '#/components/schemas/v1CustomTargetKey' description: List of custom target keys matching the query criteria. prev_cursor: type: string description: Cursor for the previous page. Omitted if this is the first page. next_cursor: type: string description: Cursor for the next page. Omitted if this is the last page. total: type: integer format: int64 description: Total number of custom target keys matching the query criteria. description: QueryCustomTargetKeys public response. required: - custom_target_keys - total additionalProperties: true publicQueryCustomTargetValuesBFFResponse: type: object properties: custom_target_values: type: array items: $ref: '#/components/schemas/v1CustomTargetValue' description: List of custom target values matching the query criteria. prev_cursor: type: string description: Cursor for the previous page. Omitted if this is the first page. next_cursor: type: string description: Cursor for the next page. Omitted if this is the last page. total: type: integer format: int64 description: Total number of custom target values matching the query criteria. description: QueryCustomTargetValues response. required: - custom_target_values - total additionalProperties: true publicQueryCustomTargetValuesResponse: type: object properties: custom_target_values: type: array items: $ref: '#/components/schemas/v1CustomTargetValue' description: List of custom target values matching the query criteria. prev_cursor: type: string description: Cursor for the previous page. Omitted if this is the first page. next_cursor: type: string description: Cursor for the next page. Omitted if this is the last page. total: type: integer format: int64 description: Total number of custom target values matching the query criteria. description: QueryCustomTargetValues public response. required: - custom_target_values - total additionalProperties: true publicQueryDailyLineItemResourcesResponse: type: object properties: line_item_resources: type: array items: $ref: '#/components/schemas/v1DailyLineItemResource' description: List of daily line item resources. description: QueryDailyLineItemResources response containing daily line item resources. required: - line_item_resources additionalProperties: true publicQueryInventoriesRequestQueryFilter: type: object properties: filters: type: array items: $ref: '#/components/schemas/publicQueryInventoriesRequestQueryFilterSingleFilter' logical_operator: $ref: '#/components/schemas/publicQueryInventoriesRequestQueryFilterLogicalOperator' additionalProperties: true publicQueryInventoriesRequestQueryFilterLogicalOperator: type: string enum: - OR default: OR publicQueryInventoriesRequestQueryFilterSingleFilter: type: object properties: column: $ref: '#/components/schemas/publicQueryInventoriesRequestQueryFilterSingleFilterFilterColumn' filter_operator: $ref: '#/components/schemas/publicQueryInventoriesRequestQueryFilterSingleFilterFilterOperator' value: $ref: '#/components/schemas/publicQueryInventoriesRequestQueryFilterSingleFilterFilterValue' additionalProperties: true publicQueryInventoriesRequestQueryFilterSingleFilterFilterColumn: type: string enum: - UNKNOWN_FILTER_COLUMN - AD_TYPE default: UNKNOWN_FILTER_COLUMN publicQueryInventoriesRequestQueryFilterSingleFilterFilterOperator: type: string enum: - UNKNOWN_FILTER_OPERATOR - EQ default: UNKNOWN_FILTER_OPERATOR publicQueryInventoriesRequestQueryFilterSingleFilterFilterValue: type: string enum: - UNKNOWN_FILTER_VALUE - ITEM - BRAND - DISPLAY - RESERVED_DISPLAY default: UNKNOWN_FILTER_VALUE publicQueryInventoriesResponse: type: object properties: inventories: type: array items: $ref: '#/components/schemas/managementv1Inventory' description: List of inventories. prev_cursor: type: string description: Indicator of the page. It will be used for the previous request. If it's the first page, then it will be omitted. next_cursor: type: string description: Indicator of the page. It will be used for the next request. If it's the last page, then it will be omitted. total_count: type: integer format: int64 description: Total number of resources to be returned. This will be the same value within the same query options. required: - inventories additionalProperties: true publicQueryInventoriesV2Response: type: object description: QueryInventoriesV2 response. additionalProperties: true publicQueryInventoriesWithAccessSummaryResponse: type: object properties: inventories: type: array items: $ref: '#/components/schemas/QueryInventoriesWithAccessSummaryResponseInventoryWithAccessSummary' description: List of inventories with summary total: type: integer format: int64 description: Total number of inventories prev_cursor: type: string description: Cursor for fetching previous list. next_cursor: type: string description: Cursor for fetching next list. description: QueryInventoriesWithAccessSummary response. required: - inventories - total additionalProperties: true publicQueryInventoryChangeLogsResponse: type: object properties: rows: type: array items: $ref: '#/components/schemas/v1EntityChangeLog' description: List of inventory change logs. page_info: $ref: '#/components/schemas/commonPageInfo' description: QueryInventoryChangeLogs response. required: - rows - page_info additionalProperties: true publicQueryInventoryMonitoringResponse: type: object properties: window_start: type: string format: date-time description: Inclusive start timestamp of the effective aligned query window. window_end: type: string format: date-time description: Exclusive end timestamp of the effective aligned query window. metrics: type: array items: $ref: '#/components/schemas/v1InventoryMonitoringMetric' description: Inventory monitoring metrics for the effective aligned query window. description: QueryInventoryMonitoring response. The response window reflects the effective aligned window. required: - window_start - window_end - metrics additionalProperties: true publicQueryInventoryStateHistoryResponse: type: object properties: rows: type: array items: $ref: '#/components/schemas/v1EntityChangeLog' description: List of inventory histories. page_info: $ref: '#/components/schemas/commonPageInfo' description: QueryInventoryStateHistory response. required: - rows - page_info additionalProperties: true publicQueryLabelChangeLogsResponse: type: object properties: rows: type: array items: $ref: '#/components/schemas/v1EntityChangeLog' description: List of label change logs. page_info: $ref: '#/components/schemas/commonPageInfo' description: QueryLabelChangeLogsResponse response. required: - rows - page_info additionalProperties: true publicQueryLabelValueEntitiesResponse: type: object properties: entity_ids: type: array items: type: string description: List of entities that have the label value. prev_cursor: type: string description: Cursor for the previous page. Omitted if this is the first page. next_cursor: type: string description: Cursor for the next page. Omitted if this is the last page. total: type: integer format: int64 description: Total number of entities matching the query criteria. description: QueryLabelValueEntities response. required: - entity_ids - total additionalProperties: true publicQueryLabelValuesWithEntitySummaryRequestQuerySorter: type: object properties: sorters: type: array items: $ref: '#/components/schemas/publicQueryLabelValuesWithEntitySummaryRequestQuerySorterSingleSorter' additionalProperties: true publicQueryLabelValuesWithEntitySummaryRequestQuerySorterSingleSorter: type: object properties: column: $ref: '#/components/schemas/publicQueryLabelValuesWithEntitySummaryRequestQuerySorterSingleSorterSorterColumn' sorter_operator: $ref: '#/components/schemas/publicQueryLabelValuesWithEntitySummaryRequestQuerySorterSingleSorterSorterOperator' additionalProperties: true publicQueryLabelValuesWithEntitySummaryRequestQuerySorterSingleSorterSorterColumn: type: string enum: - UNKNOWN_SORTER_COLUMN - LABEL_NAME - LABEL_VALUE_NAME default: UNKNOWN_SORTER_COLUMN publicQueryLabelValuesWithEntitySummaryRequestQuerySorterSingleSorterSorterOperator: type: string enum: - UNKNOWN_SORTER_OPERATOR - ASC - DESC default: UNKNOWN_SORTER_OPERATOR publicQueryLabelValuesWithEntitySummaryResponse: type: object properties: label_values: type: array items: $ref: '#/components/schemas/QueryLabelValuesWithEntitySummaryResponseLabelValueWithEntitySummary' description: List of label values matching the query criteria. prev_cursor: type: string description: Cursor for the previous page. Omitted if this is the first page. next_cursor: type: string description: Cursor for the next page. Omitted if this is the last page. total: type: integer format: int64 description: Total number of label values matching the query criteria. description: QueryLabelValues response. required: - label_values - total additionalProperties: true publicQueryLabelValuesWithInventoryAccessResponse: type: object properties: label_values: type: array items: $ref: '#/components/schemas/publicQueryLabelValuesWithInventoryAccessResponseLabelValueWithAccess' description: List of label values with access info total: type: integer format: int64 description: Total number of label values prev_cursor: type: string description: Cursor for fetching previous list next_cursor: type: string description: Cursor for fetching next list description: QueryLabelValuesWithInventoryAccess response. required: - label_values - total additionalProperties: true publicQueryLabelValuesWithInventoryAccessResponseLabelValueWithAccess: type: object properties: label_name: type: string label_value: $ref: '#/components/schemas/v1LabelValue' access: $ref: '#/components/schemas/v1LabelValueAccessType' num_of_associated_ad_accounts: type: integer format: int64 required: - label_name - label_value - access - num_of_associated_ad_accounts additionalProperties: true publicQueryLabelValuesWithPredefinedAudienceAccessResponse: type: object properties: label_values: type: array items: $ref: '#/components/schemas/publicQueryLabelValuesWithPredefinedAudienceAccessResponseLabelValueWithAccess' description: List of label values with access info total: type: string format: uint64 description: Total number of label values prev_cursor: type: string description: Cursor for fetching previous list next_cursor: type: string description: Cursor for fetching next list description: QueryLabelValuesWithPredefinedAudienceAccess response. required: - label_values - total additionalProperties: true publicQueryLabelValuesWithPredefinedAudienceAccessResponseLabelValueWithAccess: type: object properties: label_name: type: string label_value: $ref: '#/components/schemas/v1LabelValue' access: $ref: '#/components/schemas/v1LabelValueAccessType' num_of_associated_ad_accounts: type: string format: uint64 required: - label_name - label_value - access additionalProperties: true publicQueryLabelsResponse: type: object properties: labels: type: array items: $ref: '#/components/schemas/managementv1Label' description: List of labels matching the query criteria. prev_cursor: type: string description: Cursor for the previous page. Omitted if this is the first page. next_cursor: type: string description: Cursor for the next page. Omitted if this is the last page. total: type: integer format: int64 description: Total number of labels matching the query criteria. description: QueryLabels response. required: - labels - total additionalProperties: true publicQueryLandingUrlChangeLogsResponse: type: object properties: rows: type: array items: $ref: '#/components/schemas/v1EntityChangeLog' description: List of landing url change logs. page_info: $ref: '#/components/schemas/commonPageInfo' description: QueryLandingUrlChangeLogsResponse required: - rows - page_info additionalProperties: true publicQueryLandingUrlsResponse: type: object properties: landing_urls: type: array items: $ref: '#/components/schemas/v1LandingUrl' description: List of landing urls. description: QueryLandingUrls response. required: - landing_urls additionalProperties: true publicQueryLifeTimeLineItemResourcesResponse: type: object properties: line_item_resources: type: array items: $ref: '#/components/schemas/v1LifeTimeLineItemResource' description: List of lifetime line item resources. description: QueryLifeTimeLineItemResources response containing lifetime line item resources. required: - line_item_resources additionalProperties: true publicQueryLineItemDailySummaryResponse: type: object properties: rows: type: array items: $ref: '#/components/schemas/v1LineItemDailyReportRow' description: List of daily summary rows. description: QueryLineItemDailySummary response containing daily summary rows. required: - rows additionalProperties: true publicQueryListingsByItemResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/v1AdAccountItemListing' prev_cursor: type: string description: Absent on the first page. next_cursor: type: string description: Absent on the last page. additionalProperties: true publicQueryOffsiteAdAccountResourcesResponse: type: object properties: offsite_campaign_resources: type: array items: $ref: '#/components/schemas/publicOffsiteCampaignResource' description: Campaign rows on this page. prev_cursor: type: string description: Cursor for the previous page. Omitted if this is the first page. next_cursor: type: string description: Cursor for the next page. Omitted if this is the last page. total_count: type: integer format: int64 description: Total number of campaigns matching the query. required: - offsite_campaign_resources additionalProperties: true publicQueryOffsiteAdAccountSummaryResponse: type: object properties: rows: type: array items: $ref: '#/components/schemas/publicOffsiteReportRow' description: Aggregated rows for the ad account (or a single campaign when offsite_campaign_id was set). [CURRENCY] yields the card total, [DATE, CURRENCY] yields the trend series. required: - rows additionalProperties: true publicQueryOffsiteAdManagerAccountResourcesResponse: type: object properties: offsite_ad_account_resources: type: array items: $ref: '#/components/schemas/publicOffsiteAdAccountResource' description: Managed ad-account rows on this page. prev_cursor: type: string description: Cursor for the previous page. Omitted if this is the first page. next_cursor: type: string description: Cursor for the next page. Omitted if this is the last page. total_count: type: integer format: int64 description: Total number of ad accounts matching the query. required: - offsite_ad_account_resources additionalProperties: true publicQueryOffsiteAdManagerAccountSummaryResponse: type: object properties: rows: type: array items: $ref: '#/components/schemas/publicOffsiteReportRow' description: Aggregated rows for the AMA's managed ad accounts. [CURRENCY] yields the card total, [DATE, CURRENCY] yields the trend series, [AD_ACCOUNT, CURRENCY] yields one row per (managed ad account, currency). required: - rows additionalProperties: true publicQueryOffsitePlatformResourcesResponse: type: object properties: offsite_ad_account_resources: type: array items: $ref: '#/components/schemas/publicOffsiteAdAccountResource' description: Ad-account rows on this page. prev_cursor: type: string description: Cursor for the previous page. Omitted if this is the first page. next_cursor: type: string description: Cursor for the next page. Omitted if this is the last page. total_count: type: integer format: int64 description: Total number of ad accounts matching the query. required: - offsite_ad_account_resources additionalProperties: true publicQueryOffsitePlatformSummaryResponse: type: object properties: rows: type: array items: $ref: '#/components/schemas/publicOffsiteReportRow' description: 'Aggregated rows. The shape depends on group_by: [CURRENCY] yields the card total, [DATE, CURRENCY] yields the trend series, [AD_MANAGER_ACCOUNT, CURRENCY] yields one row per (AMA, currency) for the AMAs tab.' required: - rows additionalProperties: true publicQueryOrderResourcesRequestOrderBy: type: object properties: column: $ref: '#/components/schemas/publicQueryOrderResourcesRequestOrderByColumn' direction: $ref: '#/components/schemas/commonOrderByDirection' additionalProperties: true publicQueryOrderResourcesRequestOrderByColumn: type: string enum: - UNKNOWN_ORDER_BY_COLUMN - ORDER_ID - UPDATED_AT default: UNKNOWN_ORDER_BY_COLUMN description: "Optional sort for order resources (any view).\n\n - ORDER_ID: Stable internal key\n - UPDATED_AT: Last\ \ update time." publicQueryOrderResourcesRequestQueryFilter: type: object properties: group_filters: type: array items: $ref: '#/components/schemas/publicQueryOrderResourcesRequestQueryFilterGroupFilter' logical_operator: $ref: '#/components/schemas/publicQueryOrderResourcesRequestQueryFilterLogicalOperator' additionalProperties: true publicQueryOrderResourcesRequestQueryFilterGroupFilter: type: object properties: filters: type: array items: $ref: '#/components/schemas/publicQueryOrderResourcesRequestQueryFilterSingleFilter' logical_operator: $ref: '#/components/schemas/publicQueryOrderResourcesRequestQueryFilterLogicalOperator' additionalProperties: true publicQueryOrderResourcesRequestQueryFilterLogicalOperator: type: string enum: - OR - AND default: OR publicQueryOrderResourcesRequestQueryFilterSingleFilter: type: object properties: column: $ref: '#/components/schemas/publicQueryOrderResourcesRequestQueryFilterSingleFilterFilterColumn' filter_operator: $ref: '#/components/schemas/publicQueryOrderResourcesRequestQueryFilterSingleFilterFilterOperator' value: type: string additionalProperties: true publicQueryOrderResourcesRequestQueryFilterSingleFilterFilterColumn: type: string enum: - UNKNOWN_FILTER_COLUMN - AD_ACCOUNT_ID - ORDER_STATE default: UNKNOWN_FILTER_COLUMN publicQueryOrderResourcesRequestQueryFilterSingleFilterFilterOperator: type: string enum: - UNKNOWN_FILTER_OPERATOR - EQ default: UNKNOWN_FILTER_OPERATOR publicQueryOrderResourcesResponse: type: object properties: order_resources: type: array items: $ref: '#/components/schemas/v1OrderResource' description: List of order resources. prev_cursor: type: string description: Cursor for previous page. next_cursor: type: string description: Cursor for next page. total_count: type: integer format: int64 description: Total count of results. description: QueryOrderResources response containing order resources and pagination info. required: - order_resources - total_count additionalProperties: true publicQueryPlacementsResponse: type: object description: QueryPlacements response. additionalProperties: true publicQueryPlatformDashboardResourcesResponse: type: object properties: resources: type: array items: $ref: '#/components/schemas/v1PlatformDashboardResource' description: Platform dashboard resources. last_updated_at: type: string format: date-time description: The most recent timestamp when the dashboard data was updated. When there are multiple components, it represents the minimum 'latest updated' timestamp across all components. next_update_at: type: string format: date-time description: The next timestamp when the dashboard data will be updated. When there are multiple components, it represents the maximum 'next updated' timestamp across all components. required: - resources - last_updated_at - next_update_at additionalProperties: true publicQueryPlatformHomeResourcesRequestQueryFilter: type: object properties: filters: type: array items: $ref: '#/components/schemas/publicQueryPlatformHomeResourcesRequestQueryFilterSingleFilter' logical_operator: $ref: '#/components/schemas/publicQueryPlatformHomeResourcesRequestQueryFilterLogicalOperator' additionalProperties: true publicQueryPlatformHomeResourcesRequestQueryFilterLogicalOperator: type: string enum: - OR default: OR publicQueryPlatformHomeResourcesRequestQueryFilterSingleFilter: type: object properties: column: $ref: '#/components/schemas/publicQueryPlatformHomeResourcesRequestQueryFilterSingleFilterFilterColumn' filter_operator: $ref: '#/components/schemas/publicQueryPlatformHomeResourcesRequestQueryFilterSingleFilterFilterOperator' value: $ref: '#/components/schemas/publicQueryPlatformHomeResourcesRequestQueryFilterSingleFilterFilterValue' additionalProperties: true publicQueryPlatformHomeResourcesRequestQueryFilterSingleFilterFilterColumn: type: string enum: - UNKNOWN_FILTER_COLUMN - AD_ACCOUNT_STATUS default: UNKNOWN_FILTER_COLUMN publicQueryPlatformHomeResourcesRequestQueryFilterSingleFilterFilterOperator: type: string enum: - UNKNOWN_FILTER_OPERATOR - EQ default: UNKNOWN_FILTER_OPERATOR publicQueryPlatformHomeResourcesRequestQueryFilterSingleFilterFilterValue: type: string enum: - UNKNOWN_FILTER_VALUE - ACTIVE - INACTIVE - SUSPENDED default: UNKNOWN_FILTER_VALUE publicQueryPlatformHomeResourcesRequestQuerySorter: type: object properties: sorters: type: array items: $ref: '#/components/schemas/publicQueryPlatformHomeResourcesRequestQuerySorterSingleSorter' additionalProperties: true publicQueryPlatformHomeResourcesRequestQuerySorterSingleSorter: type: object properties: column: $ref: '#/components/schemas/publicQueryPlatformHomeResourcesRequestQuerySorterSingleSorterSorterColumn' sorter_operator: $ref: '#/components/schemas/publicQueryPlatformHomeResourcesRequestQuerySorterSingleSorterSorterOperator' additionalProperties: true publicQueryPlatformHomeResourcesRequestQuerySorterSingleSorterSorterColumn: type: string enum: - UNKNOWN_SORTER_COLUMN - AD_ACCOUNT_ID - AD_ACCOUNT_TITLE - AD_ACCOUNT_STATUS - IMPRESSIONS - CLICKS - CTR - AD_SPEND - CPM - CPC - TOTAL_PURCHASE - DIRECT_PURCHASE - INDIRECT_PURCHASE - TOTAL_SALES - DIRECT_SALES - INDIRECT_SALES - TOTAL_ROAS - DIRECT_ROAS - INDIRECT_ROAS - TOTAL_ACOS - DIRECT_ACOS - INDIRECT_ACOS - CR default: UNKNOWN_SORTER_COLUMN publicQueryPlatformHomeResourcesRequestQuerySorterSingleSorterSorterOperator: type: string enum: - UNKNOWN_SORTER_OPERATOR - ASC - DESC default: UNKNOWN_SORTER_OPERATOR publicQueryPlatformHomeResourcesResponse: type: object properties: platform_home_resources: type: array items: $ref: '#/components/schemas/v1PlatformHomeResource' description: List of platform home resources prev_cursor: type: string description: Indicator of the page. It will be used for the previous request. If it's the first page, then it will be omitted. next_cursor: type: string description: Indicator of the page. It will be used for the next request. If it's the last page, then it will be omitted. total_count: type: integer format: int64 description: Total number of resources to be returned. This will be the same value within the same query options. description: QueryPlatformHomeResources response required: - platform_home_resources additionalProperties: true publicQueryPlatformInsightResourcesResponse: type: object properties: resources: type: array items: $ref: '#/components/schemas/v1PlatformInsightResource' description: Platform insight resources. last_updated_at: type: string format: date-time description: Timestamp when the platform insights were last updated. next_update_at: type: string format: date-time description: Timestamp when the platform insights will be updated next. required: - resources - last_updated_at - next_update_at additionalProperties: true publicQueryPlatformSummaryResponse: type: object properties: rows: type: array items: $ref: '#/components/schemas/v1PlatformSummaryRow' description: Rows of platform-level summarized reporting. description: QueryPlatformSummary response required: - rows additionalProperties: true publicQueryPredefinedAudienceChangeLogsResponse: type: object properties: rows: type: array items: $ref: '#/components/schemas/v1PredefinedAudienceChangeLog' description: List of predefined audience change logs. page_info: $ref: '#/components/schemas/commonPageInfo' description: QueryPredefinedAudienceChangeLogs response. required: - rows - page_info additionalProperties: true publicQueryPredefinedAudiencesRequestQuerySorter: type: object properties: sorters: type: array items: $ref: '#/components/schemas/publicQueryPredefinedAudiencesRequestQuerySorterSingleSorter' description: Query sorter. additionalProperties: true publicQueryPredefinedAudiencesRequestQuerySorterSingleSorter: type: object properties: column: $ref: '#/components/schemas/publicQueryPredefinedAudiencesRequestQuerySorterSingleSorterSorterColumn' sorter_operator: $ref: '#/components/schemas/publicQueryPredefinedAudiencesRequestQuerySorterSingleSorterSorterOperator' additionalProperties: true publicQueryPredefinedAudiencesRequestQuerySorterSingleSorterSorterColumn: type: string enum: - UNKNOWN_SORTER_COLUMN - SIZE - AUDIENCE_LABEL default: UNKNOWN_SORTER_COLUMN publicQueryPredefinedAudiencesRequestQuerySorterSingleSorterSorterOperator: type: string enum: - UNKNOWN_SORTER_OPERATOR - ASC - DESC default: UNKNOWN_SORTER_OPERATOR publicQueryPredefinedAudiencesResponse: type: object properties: audiences: type: array items: $ref: '#/components/schemas/managementv1PredefinedAudience' description: Predefined audiences. required: - audiences additionalProperties: true publicQueryPredefinedAudiencesWithAccessSummaryResponse: type: object properties: audiences: type: array items: $ref: '#/components/schemas/QueryPredefinedAudiencesWithAccessSummaryResponsePredefinedAudienceWithSummary' description: List of audiences with summary total: type: string format: uint64 description: Total number of audiences prev_cursor: type: string description: Cursor for fetching previous list next_cursor: type: string description: Cursor for fetching next list description: QueryPredefinedAudiencesWithAccessSummary response. required: - audiences - total additionalProperties: true publicQueryReservedInventoryForecastResponse: type: object properties: imp: type: string format: uint64 status: $ref: '#/components/schemas/publicQueryReservedInventoryForecastResponseStatus' additionalProperties: true publicQueryReservedInventoryForecastResponseStatus: type: string enum: - UNKNOWN - OK - INSUFFICIENT_DATA - TARGETING_FORECAST_UNAVAILABLE default: UNKNOWN publicQuerySellersResponse: type: object properties: sellers: type: array items: $ref: '#/components/schemas/v1Seller' description: Seller information. description: QuerySellers response. required: - sellers additionalProperties: true publicQuerySpendCapCampaignAssignmentsResponse: type: object properties: campaign_assignment_scope: $ref: '#/components/schemas/SpendCapCampaignAssignmentScope' assignments: type: array items: $ref: '#/components/schemas/v1SpendCapCampaignAssignment' description: Campaign assignments applied to the spend cap. prev_cursor: type: string description: Cursor for fetching previous list. next_cursor: type: string description: Cursor for fetching next list. total_count: type: integer format: int64 description: Total number of campaign assignments matching the same query options. required: - campaign_assignment_scope - assignments additionalProperties: true publicQuerySpendCapTransactionLogResponse: type: object properties: spend_cap_transaction_logs: type: array items: $ref: '#/components/schemas/v1SpendCapTransactionLog' description: List of SpendCapTransactionLog. prev_cursor: type: string description: Cursor for previous page. If it's the first page, then it will be omitted. next_cursor: type: string description: Cursor for next page. If it's the last page, then it will be omitted. total_count: type: integer format: int64 description: Total number of items. additionalProperties: true publicQuerySpendCapsByAdAccountOverviewRequestQueryFilter: type: object properties: filters: type: array items: $ref: '#/components/schemas/publicQuerySpendCapsByAdAccountOverviewRequestQueryFilterSingleFilter' logical_operator: $ref: '#/components/schemas/publicQuerySpendCapsByAdAccountOverviewRequestQueryFilterLogicalOperator' additionalProperties: true publicQuerySpendCapsByAdAccountOverviewRequestQueryFilterLogicalOperator: type: string enum: - OR default: OR publicQuerySpendCapsByAdAccountOverviewRequestQueryFilterSingleFilter: type: object properties: column: $ref: '#/components/schemas/publicQuerySpendCapsByAdAccountOverviewRequestQueryFilterSingleFilterFilterColumn' filter_operator: $ref: '#/components/schemas/publicQuerySpendCapsByAdAccountOverviewRequestQueryFilterSingleFilterFilterOperator' value: type: string additionalProperties: true publicQuerySpendCapsByAdAccountOverviewRequestQueryFilterSingleFilterFilterColumn: type: string enum: - UNKNOWN_FILTER_COLUMN - AD_MANAGER_ACCOUNT_ID default: UNKNOWN_FILTER_COLUMN publicQuerySpendCapsByAdAccountOverviewRequestQueryFilterSingleFilterFilterOperator: type: string enum: - UNKNOWN_FILTER_OPERATOR - EQ default: UNKNOWN_FILTER_OPERATOR publicQuerySpendCapsByAdAccountOverviewResponse: type: object properties: spend_caps_by_ad_account_overviews: type: array items: $ref: '#/components/schemas/QuerySpendCapsByAdAccountOverviewResponseSpendCapsByAdAccountOverview' description: List of spend cap overviews by ad account. total: type: integer format: int64 description: Total number of spend cap detail overviews. prev_cursor: type: string description: Cursor for fetching previous list. next_cursor: type: string description: Cursor for fetching next list. additionalProperties: true publicQuerySpendCapsOverviewRequestQueryFilter: type: object properties: group_filters: type: array items: $ref: '#/components/schemas/publicQuerySpendCapsOverviewRequestQueryFilterGroupFilter' logical_operator: $ref: '#/components/schemas/publicQuerySpendCapsOverviewRequestQueryFilterLogicalOperator' additionalProperties: true publicQuerySpendCapsOverviewRequestQueryFilterGroupFilter: type: object properties: filters: type: array items: $ref: '#/components/schemas/publicQuerySpendCapsOverviewRequestQueryFilterSingleFilter' logical_operator: $ref: '#/components/schemas/publicQuerySpendCapsOverviewRequestQueryFilterGroupFilterLogicalOperator' additionalProperties: true publicQuerySpendCapsOverviewRequestQueryFilterGroupFilterLogicalOperator: type: string enum: - OR default: OR publicQuerySpendCapsOverviewRequestQueryFilterLogicalOperator: type: string enum: - AND default: AND publicQuerySpendCapsOverviewRequestQueryFilterSingleFilter: type: object properties: column: $ref: '#/components/schemas/publicQuerySpendCapsOverviewRequestQueryFilterSingleFilterFilterColumn' filter_operator: $ref: '#/components/schemas/publicQuerySpendCapsOverviewRequestQueryFilterSingleFilterFilterOperator' status: $ref: '#/components/schemas/publicQuerySpendCapsOverviewRequestQueryFilterSingleFilterSpendCapStatusFilterValue' ad_account_id: type: string ad_manager_account_id: type: string purpose: $ref: '#/components/schemas/SingleFilterSpendCapPurposeFilterValue' additionalProperties: true publicQuerySpendCapsOverviewRequestQueryFilterSingleFilterFilterColumn: type: string enum: - UNKNOWN_FILTER_COLUMN - STATUS - AD_ACCOUNT_ID - AD_MANAGER_ACCOUNT_ID - PURPOSE default: UNKNOWN_FILTER_COLUMN publicQuerySpendCapsOverviewRequestQueryFilterSingleFilterFilterOperator: type: string enum: - UNKNOWN_FILTER_OPERATOR - EQ default: UNKNOWN_FILTER_OPERATOR publicQuerySpendCapsOverviewRequestQueryFilterSingleFilterSpendCapStatusFilterValue: type: string enum: - UNKNOWN_SPEND_CAP_STATUS_FILTER_VALUE - SCHEDULED - INACTIVE - ACTIVE - ENDED - DEPLETED - ERROR default: UNKNOWN_SPEND_CAP_STATUS_FILTER_VALUE publicQuerySpendCapsOverviewResponse: type: object properties: spend_cap_overviews: type: array items: $ref: '#/components/schemas/v1SpendCapOverview' description: List of spend cap overviews. total_count: type: integer format: int64 description: Total number of spend cap overviews matching the same query options. prev_cursor: type: string description: Cursor for fetching previous list. next_cursor: type: string description: Cursor for fetching next list. additionalProperties: true publicQuerySpendingLimitCreditHistoryResponse: type: object properties: transaction_histories: type: array items: $ref: '#/components/schemas/v1SpendingLimitCreditHistory' prev_cursor: type: string next_cursor: type: string total_count: type: integer format: int64 required: - transaction_histories - total_count additionalProperties: true publicQuerySpendingLimitsResponse: type: object properties: result: type: object additionalProperties: $ref: '#/components/schemas/publicSpendingLimits' description: Map of spending limits keyed by an ad account id. description: QuerySpendingLimits response. required: - result additionalProperties: true publicQueryTopSellersOnboardingPlatformInsightDetailsResponse: type: object properties: ad_accounts: type: array items: $ref: '#/components/schemas/QueryTopSellersOnboardingPlatformInsightDetailsResponseLargestSeller' description: List of top sellers who are not onboarded. prev_cursor: type: string description: Cursor for fetching previous page. next_cursor: type: string description: Cursor for fetching next page. total: type: integer format: int64 description: Total number of top sellers not onboarded. last_updated_at: type: string format: date-time description: Timestamp when the platform insights were last updated. next_update_at: type: string format: date-time description: Timestamp when the platform insights will be updated next. required: - ad_accounts - total - last_updated_at - next_update_at additionalProperties: true publicQueryUserAccessChangeLogsResponse: type: object properties: rows: type: array items: $ref: '#/components/schemas/v1UserAccessChangeLog' description: List of UserAccessChangeLogs. page_info: $ref: '#/components/schemas/commonPageInfo' description: QueryUserAccessChangeLogs response. required: - rows - page_info additionalProperties: true publicQueryUserJoinRequestsResponse: type: object properties: user_join_requests: type: array items: $ref: '#/components/schemas/v1UserJoinRequest' description: UserJoinRequest information. description: QueryUserJoinRequests response. required: - user_join_requests additionalProperties: true publicQueryUserRegistrationsResponse: type: object properties: user_registration: $ref: '#/components/schemas/v1UserRegistration' description: QueryUserRegistrations response required: - user_registration additionalProperties: true publicQueryWalletAccountHistoryResponse: type: object properties: rows: type: array items: $ref: '#/components/schemas/v1WalletAccountHistoryLog' description: List of WalletAccountHistoryLogs. page_info: $ref: '#/components/schemas/commonPageInfo' description: QueryWalletAccountHistory response. required: - rows - page_info additionalProperties: true publicQueryWalletTransactionHistoryResponse: type: object properties: transaction_histories: type: array items: $ref: '#/components/schemas/v1WalletTransactionHistory' description: List of WalletTransactionHistory. prev_cursor: type: string description: Cursor for previous page. If it's the first page, then it will be omitted. next_cursor: type: string description: Cursor for next page. If it's the last page, then it will be omitted. total_count: type: integer format: int64 description: Total number of items. description: QueryWalletTransactionHistory response. required: - transaction_histories - total_count additionalProperties: true publicQueryWalletsResponse: type: object properties: result: type: object additionalProperties: $ref: '#/components/schemas/publicWallets' description: Map of wallets keyed by an ad account id. description: QueryWallets response. required: - result additionalProperties: true publicQueryWebhookChangeLogsResponse: type: object properties: rows: type: array items: $ref: '#/components/schemas/v1EntityChangeLog' description: List of webhook change logs. page_info: $ref: '#/components/schemas/commonPageInfo' description: QueryWebhookChangeLogs response. required: - rows - page_info additionalProperties: true publicQueryWebhookDeliveriesResponse: type: object properties: deliveries: type: array items: $ref: '#/components/schemas/v1WebhookDelivery' description: Webhook deliveries on the current page. prev_cursor: type: string description: Cursor for the previous page. Omitted on the first page. next_cursor: type: string description: Cursor for the next page. Omitted on the last page. total_count: type: integer format: int64 description: Total number of deliveries matching the filters. Computed on the first page and cached in the cursor. description: QueryWebhookDeliveries response. required: - deliveries - total_count additionalProperties: true publicReadAdAccountResponse: type: object properties: ad_account: $ref: '#/components/schemas/managementv1AdAccount' description: ReadAdAccount response. required: - ad_account additionalProperties: true publicReadAdAccountUserResponse: type: object properties: user: $ref: '#/components/schemas/v1AdAccountUser' description: ReadAdAccountUser response required: - user additionalProperties: true publicReadAdManagerAccountReportSummaryResponse: type: object properties: rows: type: array items: $ref: '#/components/schemas/v1AdManagerAccountSummaryRow' description: Rows of summarized ad manager account reporting. description: ReadAdManagerAccountReportSummary response required: - rows additionalProperties: true publicReadAdManagerAccountResponse: type: object properties: ad_manager_account: $ref: '#/components/schemas/v1AdManagerAccount' description: ReadAdManagerAccount response. required: - ad_manager_account additionalProperties: true publicReadAdManagerAccountUserResponse: type: object properties: user: $ref: '#/components/schemas/v1AdManagerAccountUser' description: ReadAdManagerAccountUser response. required: - user additionalProperties: true publicReadAudienceReportSummaryResponse: type: object properties: rows: type: array items: $ref: '#/components/schemas/v1AudienceReportSummaryRow' description: Rows of summarized audience reporting. description: ReadAudienceReportSummary response required: - rows additionalProperties: true publicReadBrandResponse: type: object properties: brand: $ref: '#/components/schemas/v1BrandContent' required: - brand additionalProperties: true publicReadBrandsBulkResponse: type: object properties: brands: type: array items: $ref: '#/components/schemas/v1BrandContent' description: Brand contents. required: - brands additionalProperties: true publicReadCampaignForecastResponse: type: object properties: status: $ref: '#/components/schemas/publicReadCampaignForecastResponseStatus' imp: $ref: '#/components/schemas/publicForecastValue' click: $ref: '#/components/schemas/publicForecastValue' purchase: $ref: '#/components/schemas/publicForecastValue' description: ReadCampaignForecast response. additionalProperties: true publicReadCampaignForecastResponseStatus: type: string enum: - UNKNOWN - OK - NOT_IN_GUIDANCE_RANGE - TARGETED_CAMPAIGN - NO_ITEMS_AVAILABLE - LOW_BUDGET default: UNKNOWN description: " - OK: Forecast values are available.\n - NOT_IN_GUIDANCE_RANGE: Forecast values are unavailable." publicReadCampaignGuidanceRequestAdType: type: string enum: - ITEM default: UNKNOWN_AD_TYPE publicReadCampaignGuidanceRequestCampaignGoalType: type: string enum: - FIXED_CPC - OPTIMIZE_ROAS - FIXED_COMMISSION_RATE default: UNKNOWN_CAMPAIGN_GOAL_TYPE publicReadCampaignGuidanceResponse: type: object properties: guided_budget_micro: $ref: '#/components/schemas/publicUInt64Guidance' guided_cpc_micro: $ref: '#/components/schemas/publicUInt64Guidance' guided_roas: $ref: '#/components/schemas/publicUInt32Guidance' guided_commission_rate: type: integer format: int64 description: Target commission rate guidance in percent. expected_metrics: type: array items: $ref: '#/components/schemas/publicExpectedGuidanceMetric' description: Expected metric increase in percent. Only valid when the target is commission rate. description: ReadCampaignGuidance response. additionalProperties: true publicReadCampaignResponse: type: object properties: campaign: $ref: '#/components/schemas/v1Campaign' description: ReadCampaign response. required: - campaign additionalProperties: true publicReadCatalogMetadataResponse: type: object properties: revision: type: string description: Revision of the catalog metadata. required: - revision additionalProperties: true publicReadCategoriesBulkResponse: type: object properties: categories: type: array items: $ref: '#/components/schemas/v1CategoryContent' description: Category contents. required: - categories additionalProperties: true publicReadCategoryResponse: type: object properties: category: $ref: '#/components/schemas/v1CategoryContent' required: - category additionalProperties: true publicReadCptSummaryResponse: type: object properties: rows: type: array items: $ref: '#/components/schemas/v1CptSummaryRow' description: Rows of summarized managed CPT reporting. description: ReadCptSummaryResponse. required: - rows additionalProperties: true publicReadCreativeOverviewResponse: type: object properties: creative_overview: $ref: '#/components/schemas/v1CreativeOverview' description: ReadCreativeOverview response. required: - creative_overview additionalProperties: true publicReadCreativeResponse: type: object properties: creative: $ref: '#/components/schemas/v1Creative' description: ReadCreative response. required: - creative additionalProperties: true publicReadCreditResponse: type: object properties: credit: $ref: '#/components/schemas/v1Credit' description: ReadCredit Response. required: - credit additionalProperties: true publicReadCustomTargetKeysBulkResponse: type: object properties: custom_target_keys: type: array items: $ref: '#/components/schemas/v1CustomTargetKey' description: Custom target keys. description: ReadCustomTargetKeysBulk response. required: - custom_target_keys additionalProperties: true publicReadCustomTargetKeysWithCustomReportBulkResponse: type: object properties: custom_target_keys: type: array items: $ref: '#/components/schemas/v1CustomTargetKey' description: Custom target keys that have available report data. 1. All keys from ad type configuration. 2. All keys from line item configuration. 3. All keys have at least one report record within 60 days. description: ReadCustomTargetKeysWithCustomReportBulk response. required: - custom_target_keys additionalProperties: true publicReadCustomTargetValuesBulkResponse: type: object properties: custom_target_values: type: array items: $ref: '#/components/schemas/v1CustomTargetValue' description: Custom target values. description: ReadCustomTargetValuesBulk response. required: - custom_target_values additionalProperties: true publicReadImageAssetResponse: type: object properties: image_asset: $ref: '#/components/schemas/v1ImageAsset' description: ReadImageAsset response. required: - image_asset additionalProperties: true publicReadInventoryReportSummaryResponse: type: object properties: rows: type: array items: $ref: '#/components/schemas/v1InventoryReportSummaryRow' description: Rows of summarized inventory reporting. description: ReadInventoryReportSummary response required: - rows additionalProperties: true publicReadInventoryResponse: type: object properties: inventory: $ref: '#/components/schemas/managementv1Inventory' description: ReadInventory response. required: - inventory additionalProperties: true publicReadItemBasedCampaignGuidanceBFFResponse: type: object properties: tracking_id: type: string description: ID to track whether the guidance result is well accepted by the client. Please include this ID when calling Campaign Create/Update API. guided_value: $ref: '#/components/schemas/ReadItemBasedCampaignGuidanceResponseGuidedValue' guided_message: type: array items: $ref: '#/components/schemas/ReadItemBasedCampaignGuidanceResponseGuidedMessage' expected_metrics: type: array items: $ref: '#/components/schemas/publicExpectedGuidanceMetric' description: Expected metric increase in percent confidence_level: $ref: '#/components/schemas/ReadItemBasedCampaignGuidanceResponseConfidenceLevel' description: ReadItemBasedCampaignGuidanceBFF response. additionalProperties: true publicReadItemBasedCampaignGuidanceResponse: type: object properties: guided_value: $ref: '#/components/schemas/ReadItemBasedCampaignGuidanceResponseGuidedValue' guided_message: type: array items: $ref: '#/components/schemas/ReadItemBasedCampaignGuidanceResponseGuidedMessage' expected_metrics: type: array items: $ref: '#/components/schemas/publicExpectedGuidanceMetric' description: Expected metric increase in percent confidence_level: $ref: '#/components/schemas/ReadItemBasedCampaignGuidanceResponseConfidenceLevel' description: ReadItemBasedCampaignGuidance response. additionalProperties: true publicReadKeywordReportSummaryResponse: type: object properties: rows: type: array items: $ref: '#/components/schemas/v1KeywordReportSummaryRow' description: Rows of summarized keyword reporting. description: ReadKeywordReportSummary response required: - rows additionalProperties: true publicReadLandingUrlResponse: type: object properties: landing_url: $ref: '#/components/schemas/v1LandingUrl' description: ReadLandingUrl response. required: - landing_url additionalProperties: true publicReadLineItemSummaryResponse: type: object properties: line_item_summary: $ref: '#/components/schemas/v1LineItemSummary' description: ReadLineItemSummary response containing line item summary. required: - line_item_summary additionalProperties: true publicReadMFAConfigurationResponse: type: object properties: mfa_config: $ref: '#/components/schemas/v1MFAConfig' description: ReadMFAConfiguration response. required: - mfa_config additionalProperties: true publicReadNotificationPreferencesWithTokenResponse: type: object properties: user_email: type: string description: The email address of the resolved user. notification_preferences: $ref: '#/components/schemas/v1NotificationPreferences' description: ReadNotificationPreferencesWithToken response additionalProperties: true publicReadOffsiteCampaignResponse: type: object properties: offsite_campaign: $ref: '#/components/schemas/v1OffsiteCampaign' required: - offsite_campaign additionalProperties: true publicReadOrderBFFResponse: type: object properties: order: $ref: '#/components/schemas/v1Order' line_items: type: array items: $ref: '#/components/schemas/v1LineItem' description: Line items associated with the order. Only included if include_line_items is true in the request. description: ReadOrder response containing order details with line items(conditional). required: - order additionalProperties: true publicReadOrderResponse: type: object properties: order: $ref: '#/components/schemas/v1Order' line_items: type: array items: $ref: '#/components/schemas/v1LineItem' description: Line items associated with the order. description: ReadOrder response containing order details with line items. required: - order additionalProperties: true publicReadOrderSummaryResponse: type: object properties: order_summary: $ref: '#/components/schemas/v1OrderSummary' description: ReadOrderSummary response containing order summary. required: - order_summary additionalProperties: true publicReadPlacementReportSummaryResponse: type: object properties: rows: type: array items: $ref: '#/components/schemas/v1PlacementReportSummaryRow' description: Rows of summarized placement reporting. description: ReadPlacementReportSummary response required: - rows additionalProperties: true publicReadPlatformAPIKeyResponse: type: object properties: api_key: $ref: '#/components/schemas/PlatformOwnerConfigAPIKey' description: ReadPlatformAPIKey response required: - api_key additionalProperties: true publicReadPlatformInfoResponse: type: object properties: platform_info: $ref: '#/components/schemas/v1PlatformInfo' description: ReadPlatformInfo response required: - platform_info additionalProperties: true publicReadPlatformOwnerConfigResponse: type: object properties: platform: $ref: '#/components/schemas/v1PlatformOwnerConfig' description: ReadPlatformOwnerConfig response. required: - platform additionalProperties: true publicReadPlatformSSOSecretResponse: type: object properties: sso_secret: type: string description: Raw string of SSO secret. description: ReadPlatformSSOSecret response required: - sso_secret additionalProperties: true publicReadPlatformUserConfigResponse: type: object properties: platform: $ref: '#/components/schemas/v1PlatformUserConfig' description: ReadPlatformUserConfig response required: - platform additionalProperties: true publicReadPredefinedAudienceSyncStatusResponse: type: object properties: status: $ref: '#/components/schemas/publicReadPredefinedAudienceSyncStatusResponseStatus' description: ReadPredefinedAudienceSyncStatus response. required: - status additionalProperties: true publicReadPredefinedAudienceSyncStatusResponseStatus: type: string enum: - UNKNOWN_STATUS - HEALTHY - DEGRADED - FAILED default: UNKNOWN_STATUS publicReadPredefinedAudiencesBulkResponse: type: object properties: audiences: type: array items: $ref: '#/components/schemas/managementv1PredefinedAudience' description: Predefined audiences. required: - audiences additionalProperties: true publicReadSellerResponse: type: object properties: seller: $ref: '#/components/schemas/v1Seller' description: ReadSeller response. required: - seller additionalProperties: true publicReadSpendCapResponse: type: object properties: spend_cap: $ref: '#/components/schemas/v1SpendCap' additionalProperties: true publicReadSpendingLimitResponse: type: object properties: spending_limit: $ref: '#/components/schemas/v1SpendingLimit' description: ReadSpendingLimit response. required: - spending_limit additionalProperties: true publicReadUserJoinRequestResponse: type: object properties: user_join_request: $ref: '#/components/schemas/v1UserJoinRequest' description: ReadUserJoinRequest response required: - user_join_request additionalProperties: true publicReadUserMFAStatusResponse: type: object properties: registration_status: $ref: '#/components/schemas/v1MFARegistrationStatus' description: ReadUserMFAStatus response. required: - registration_status additionalProperties: true publicReadUserResponse: type: object properties: user: $ref: '#/components/schemas/v1User' description: ReadUser response required: - user additionalProperties: true publicReadVideoAssetResponse: type: object properties: video_asset: $ref: '#/components/schemas/v1VideoAsset' description: ReadVideoAsset response. required: - video_asset additionalProperties: true publicReadWalletResponse: type: object properties: wallet: $ref: '#/components/schemas/v1Wallet' description: ReadWallet response. required: - wallet additionalProperties: true publicReadWebhookDeliveryResponse: type: object properties: delivery: $ref: '#/components/schemas/v1WebhookDelivery' description: ReadWebhookDelivery response. required: - delivery additionalProperties: true publicReadWebhookEndpointResponse: type: object properties: webhook_endpoint: $ref: '#/components/schemas/v1WebhookEndpoint' description: ReadWebhookEndpoint response. required: - webhook_endpoint additionalProperties: true publicReadWebhookSigningKeyResponse: type: object properties: signing_key: $ref: '#/components/schemas/v1WebhookSigningKey' description: ReadWebhookSigningKey response. required: - signing_key additionalProperties: true publicRepresentedError: type: object properties: code: type: integer format: int32 description: The status code, which should be an enum value of google.rpc.Code.(https://developers.google.com/actions-center/reference/grpc-api/status_codes) message: type: string description: The detailed message of responded error. details: type: array items: $ref: '#/components/schemas/RepresentedErrorDetail' description: The detailed information of responded error. Please refer to the error category section in guides for more detailed information.(https://rmp-docs.moloco.com/docs/management-api-error-categories) title: Overridden from grpc status(https://github.com/grpc/grpc/blob/master/src/proto/grpc/status/status.proto) required: - code - message - details additionalProperties: true publicResetUserMFASettingResponse: type: object additionalProperties: true publicRevealWebhookSigningKeyResponse: type: object properties: signing_key: $ref: '#/components/schemas/v1WebhookSigningKey' secret: type: string description: The raw signing secret. description: RevealWebhookSigningKey response. required: - signing_key - secret additionalProperties: true publicRevokeWebhookSigningKeyResponse: type: object additionalProperties: true publicRotateDataExportKeyResponse: type: object properties: key_id: type: string description: The unique identifier for the newly created HMAC key. secret_key: type: string description: The raw HMAC secret key. Only returned once upon creation. description: RotateDataExportKey response containing the new HMAC credentials. required: - key_id - secret_key additionalProperties: true publicRunCatalogFeedResponse: type: object additionalProperties: true publicSendDirectTestWebhookResponse: type: object properties: http_status: type: integer format: int32 description: HTTP status code returned by the target URL. response_snippet: type: string description: Truncated snippet of the target's response body. description: SendDirectTestWebhook response. required: - http_status additionalProperties: true publicSendTestWebhookResponse: type: object properties: batch_id: type: string description: Identifier of the dispatched test delivery batch. description: SendTestWebhook response. required: - batch_id additionalProperties: true publicSpendingLimits: type: object properties: spending_limits: type: array items: $ref: '#/components/schemas/v1SpendingLimit' description: List of SpendingLimits. description: QuerySpendingLimits response. required: - spending_limits additionalProperties: true publicStartMFAEnrollmentResponse: type: object properties: otpauth_url: type: string description: OTP Auth URL for setting up TOTP authenticator apps. factor_id: type: string description: Identifier of the MFA factor. manual_entry: $ref: '#/components/schemas/StartMFAEnrollmentResponseManualEntry' description: StartMFAEnrollment response. required: - otpauth_url - factor_id - manual_entry additionalProperties: true publicSuggestScenesResponse: type: object properties: scenes: type: array items: $ref: '#/components/schemas/SuggestScenesResponseScene' description: Suggested scene concepts for the catalog item. meta: $ref: '#/components/schemas/v1CreativeAgentResponseMeta' description: SuggestScenes response. required: - scenes - meta additionalProperties: true publicTopUpCreditResponse: type: object properties: credit: $ref: '#/components/schemas/v1Credit' description: TopUpCredit response. additionalProperties: true publicTopUpWalletResponse: type: object properties: wallet: $ref: '#/components/schemas/v1Wallet' description: TopUpWallet response. additionalProperties: true publicTrustedDevice: type: object properties: id: type: string description: Unique identifier of the trusted device. device_fingerprint: $ref: '#/components/schemas/publicDeviceFingerprint' created_at: type: string format: date-time description: Timestamp when the device was trusted. expires_at: type: string format: date-time description: Timestamp when the trusted device expires. last_used_at: type: string format: date-time description: Timestamp when the device was last used for login. description: A trusted device for MFA bypass. required: - id - device_fingerprint - created_at - expires_at - last_used_at additionalProperties: true publicUInt32Guidance: type: object properties: value: type: integer format: uint32 description: Value of the guidance. min: type: integer format: uint32 description: Minimum value of the guidance. max: type: integer format: uint32 description: Maximum value of the guidance. description: Guidance for uint32 value. It is used for ROAS guidance. The value is in percent. required: - value - min - max additionalProperties: true publicUInt64Guidance: type: object properties: value: type: integer format: uint64 description: Value of the guidance. min: type: integer format: uint64 description: Minimum value of the guidance. max: type: integer format: uint64 description: Maximum value of the guidance. description: Guidance for uint64 value. It is used for budget and fixed CPC guidance. required: - value - min - max additionalProperties: true publicUpdateAdAccountRequestAdAccountInfo: type: object properties: title: type: string description: A descriptive name of the ad account. updated_at: type: string format: date-time description: Updated timestamp. This should match the updated timestamp updated_at of the ad account, which is able to check with ReadAdAccount API. required: - title - updated_at additionalProperties: true publicUpdateAdAccountResponse: type: object properties: ad_account: $ref: '#/components/schemas/managementv1AdAccount' description: UpdateAdAccount response. required: - ad_account additionalProperties: true publicUpdateAdAccountStateInfoResponse: type: object properties: state_info: $ref: '#/components/schemas/v1AdAccountStateInfo' description: UpdateAdAccountStateInfo response. required: - state_info additionalProperties: true publicUpdateAdAccountUserRequestAdAccountUserParams: type: object properties: name: type: string description: The name of the Ad Account User. If this field is not set, a parsed email will be used. role: $ref: '#/components/schemas/v1RoleName' updated_at: type: string format: date-time description: Updated timestamp. Set internally during creation, but required during update. required: - role - updated_at additionalProperties: true publicUpdateAdAccountUserResponse: type: object properties: user: $ref: '#/components/schemas/v1AdAccountUser' description: UpdateAdAccountUser response required: - user additionalProperties: true publicUpdateAdManagerAccountRequestAdManagerAccountInfo: type: object properties: title: type: string description: Title of the AdManagerAccount. managing_ad_account_ids: type: array items: type: string description: List of ad account ids that the AdManagerAccount manages. updated_at: type: string format: date-time description: Updated timestamp of the AdManagerAccount. description: AdManagerAccount info. required: - title additionalProperties: true publicUpdateAdManagerAccountResponse: type: object properties: ad_manager_account: $ref: '#/components/schemas/v1AdManagerAccount' description: UpdateAdManagerAccount response. required: - ad_manager_account additionalProperties: true publicUpdateAdManagerAccountUserRequestAdManagerAccountUserInfo: type: object properties: name: type: string description: The name of the Ad Manager Account User. If this field is not provided, it will not be updated. role: $ref: '#/components/schemas/v1RoleName' updated_at: type: string format: date-time description: The timestamp when the user is updated. description: AdManagerAccount User info. required: - role - updated_at additionalProperties: true publicUpdateAdManagerAccountUserResponse: type: object properties: user: $ref: '#/components/schemas/v1AdManagerAccountUser' description: UpdateAdManagerAccountUser response. required: - user additionalProperties: true publicUpdateCampaignEnablingStateResponse: type: object properties: campaign: $ref: '#/components/schemas/v1Campaign' description: UpdateCampaignEnablingState response. required: - campaign additionalProperties: true publicUpdateCampaignRequestCampaignParams: type: object properties: title: type: string description: A descriptive name of the campaign. hidden: type: boolean description: 'if this value is true, it means that a campaign is no longer visible and has been archived. Only disabled or ended campaigns could be hidden. Optional(Default: False).' schedule: $ref: '#/components/schemas/rmpcommonTimeInterval' daily_budget: $ref: '#/components/schemas/rmpcommonMoneyMicro' updated_at: type: string format: date-time description: This field represents the last time the campaign was modified. Make sure this value matches the latest updated_at you received from the ReadCampaign API. budget: $ref: '#/components/schemas/rmpcommonBudget' targeting: $ref: '#/components/schemas/v1Targeting' goal: $ref: '#/components/schemas/managementv1CampaignGoal' catalog_item_ids: type: array items: type: string description: List of catalog items belonging to the campaign. Required when the campaign is MANUAL_SELECTION item selection type. A catalog item id can be a product id or deal id in the catalogs. Note that an item can belong to multiple campaigns. enabling_state: $ref: '#/components/schemas/commonCampaignEnablingState' item_selection: $ref: '#/components/schemas/CampaignCampaignItemSelection' assets: type: array items: $ref: '#/components/schemas/publicUpdateCampaignRequestCampaignParamsAssetParams' description: Asset information for the brand campaign. landing_pages: type: array items: $ref: '#/components/schemas/publicUpdateCampaignRequestCampaignParamsCampaignLandingPageParams' description: Landing page information for the brand campaign. ad_operation_type: $ref: '#/components/schemas/campaignAdOperationType' alias: type: string description: The alias is the platform-defined identifier for the campaign. description: List of params required to update a campaign. required: - schedule - goal - enabling_state - updated_at additionalProperties: true publicUpdateCampaignRequestCampaignParamsAssetParams: type: object properties: id: type: string description: The id of the asset. Must be set. banner: $ref: '#/components/schemas/commonAssetBanner' logo: $ref: '#/components/schemas/commonAssetLogo' headline: $ref: '#/components/schemas/commonAssetHeadline' custom_text: $ref: '#/components/schemas/commonAssetCustomText' cta: $ref: '#/components/schemas/commonAssetCallToAction' created_at: type: string format: date-time description: Make sure this value matches the created_at you received from the ReadCampaign API. updated_at: type: string format: date-time description: Make sure this value matches the latest updated_at you received from the ReadCampaign API. description: Detailed settings for the campaign asset. additionalProperties: true publicUpdateCampaignRequestCampaignParamsCampaignLandingPageParams: type: object properties: type: $ref: '#/components/schemas/CampaignLandingPageCampaignLandingPageType' custom_url_setting: $ref: '#/components/schemas/CampaignLandingPageCustomUrlSetting' product_detail_setting: $ref: '#/components/schemas/commonCampaignLandingPageProductDetailSetting' product_list_setting: $ref: '#/components/schemas/CampaignLandingPageProductListSetting' id: type: string description: The id of the landing page. Must be set. created_at: type: string format: date-time description: Make sure this value matches the created_at you received from the ReadCampaign API. updated_at: type: string format: date-time description: Make sure this value matches the latest updated_at you received from the ReadCampaign API. description: Detailed settings for the landing page. required: - type additionalProperties: true publicUpdateCampaignResponse: type: object properties: campaign: $ref: '#/components/schemas/v1Campaign' description: UpdateCampaign response. required: - campaign additionalProperties: true publicUpdateCampaignReviewResponse: type: object properties: campaign_review: $ref: '#/components/schemas/v1CampaignReview' description: UpdateCampaignReview response. required: - campaign_review additionalProperties: true publicUpdateCampaignReviewsBulkResponse: type: object properties: campaign_reviews: type: array items: $ref: '#/components/schemas/v1CampaignReview' description: Campaign reviews information. description: UpdateCampaignReviewsBulk response. required: - campaign_reviews additionalProperties: true publicUpdateCreativeRequestUploadCreativeRequest: type: object properties: file_bytes: type: string format: byte description: The file bytes. readOnly: true mime_type: type: string description: The mime type. readOnly: true file_name: type: string description: The file name. readOnly: true creative: $ref: '#/components/schemas/publicUpdateCreativeRequestUploadCreativeRequestCreativeParams' description: Parameters to upload creative. required: - creative additionalProperties: true publicUpdateCreativeRequestUploadCreativeRequestCreativeParams: type: object properties: title: type: string description: A descriptive name of the creative. type: $ref: '#/components/schemas/v1CreativeType' image_source: $ref: '#/components/schemas/publicCreativeImageSourceParams' updated_at: type: string format: date-time description: Updated timestamp. Set internally during creation, but required during update. This should match the updated timestamp updated_at of the creative, which is able to check with ReadCreative API. description: Definition of a creative. required: - type - updated_at additionalProperties: true publicUpdateCreativeResponse: type: object properties: creative: $ref: '#/components/schemas/v1Creative' description: UpdateCreative response. required: - creative additionalProperties: true publicUpdateCreativeReviewStatusResponse: type: object properties: review_status: $ref: '#/components/schemas/v1CreativeReviewStatus' description: UpdateCreativeReviewStatus response. required: - review_status additionalProperties: true publicUpdateInventoryAccessConfigRequestAdAccountsAllowListConfig: type: object properties: ad_account_ids_to_be_added: type: array items: type: string title: Ad account ids to be added to the allowed_ad_accounts ad_account_ids_to_be_removed: type: array items: type: string title: Ad account ids to be removed from the allowed_ad_accounts additionalProperties: true publicUpdateInventoryAccessConfigRequestPublicAccessConfig: type: object additionalProperties: true publicUpdateInventoryAccessConfigRequestRestrictedConfig: type: object additionalProperties: true publicUpdateInventoryAccessConfigResponse: type: object properties: inventory: $ref: '#/components/schemas/managementv1Inventory' description: UpdateInventoryAccessConfig response. required: - inventory additionalProperties: true publicUpdateInventoryResponse: type: object properties: inventory: $ref: '#/components/schemas/managementv1Inventory' description: UpdateInventory response. required: - inventory additionalProperties: true publicUpdateInventoryVisibilityBulkRequestUpdate: type: object properties: inventory_id: type: string description: Identifier of the inventory. visibility: $ref: '#/components/schemas/v1EntityVisibilityType' required: - inventory_id - visibility additionalProperties: true publicUpdateInventoryVisibilityBulkResponse: type: object additionalProperties: true publicUpdateInventoryWithAccessRequestAdAccountAccessUpdate: type: object properties: ad_account_id: type: string description: Identifier of the ad account. access: $ref: '#/components/schemas/v1AdAccountAccessType' required: - ad_account_id - access additionalProperties: true publicUpdateInventoryWithAccessRequestLabelValueAccessUpdate: type: object properties: label_value_id: type: string description: Identifier of the label value. access: $ref: '#/components/schemas/v1LabelValueAccessType' required: - label_value_id - access additionalProperties: true publicUpdateInventoryWithAccessResponse: type: object additionalProperties: true publicUpdateItemStatusBulkResponse: type: object properties: success_items: type: array items: $ref: '#/components/schemas/v1UpdateItemSuccessInfo' description: List of items with updated status. failure_items: type: array items: $ref: '#/components/schemas/v1UpdateItemFailureInfo' description: List of failure information that are failed. description: UpdateItemStatusBulk response. required: - success_items additionalProperties: true publicUpdateLabelRequestLabelParams: type: object properties: name: type: string description: A descriptive name of the label. Must be unique across the platform. updated_at: type: string format: date-time description: This field is required to avoid race condition when updating the label. This field must be the same as existing label's updated_at. When update is successful, the updated_at field will be updated to the current timestamp. description: Parameters for updating a label. required: - name - updated_at additionalProperties: true publicUpdateLabelResponse: type: object properties: label: $ref: '#/components/schemas/managementv1Label' description: UpdateLabel response. required: - label additionalProperties: true publicUpdateLabelValueAdAccountRelationshipBulkRequestUpdate: type: object properties: ad_account_id: type: string description: Identifier of the ad account type: $ref: '#/components/schemas/UpdateLabelValueAdAccountRelationshipBulkRequestUpdateType' additionalProperties: true publicUpdateLabelValueAdAccountRelationshipBulkResponse: type: object description: UpdateLabelValueAdAccountRelationshipBulk response. additionalProperties: true publicUpdateLabelValueRequestLabelValueParams: type: object properties: name: type: string description: A descriptive name of the label value. updated_at: type: string format: date-time description: This field is required to avoid race condition when updating the label value. This field must be the same as existing label value's updated_at. When update is successful, the updated_at field will be updated to the current timestamp. description: Parameters for updating a label value. required: - name - updated_at additionalProperties: true publicUpdateLabelValueResponse: type: object properties: label_value: $ref: '#/components/schemas/v1LabelValue' description: UpdateLabelValue response. required: - label_value additionalProperties: true publicUpdateLandingUrlResponse: type: object properties: landing_url: $ref: '#/components/schemas/v1LandingUrl' description: UpdateLandingUrl response. required: - landing_url additionalProperties: true publicUpdateLandingUrlReviewStatusResponse: type: object properties: review_status: $ref: '#/components/schemas/v1LandingUrlReviewStatus' description: UpdateLandingUrlReviewStatus response. required: - review_status additionalProperties: true publicUpdateLineItemRequestLineItemParams: type: object properties: priority: type: integer format: int64 description: Priority of the line item. The lower the number, the higher the priority. For RESERVED_IMPRESSIONS line items, valid values are 1-10; omit to leave the existing priority unchanged. Must be omitted for RESERVED_TIME line items. enabling_state: $ref: '#/components/schemas/commonCampaignEnablingState' updated_at: type: string format: date-time description: This field represents the last time the line item was modified. Make sure this value matches the latest updated_at you received from the Read API. required: - enabling_state - updated_at additionalProperties: true publicUpdateLineItemResponse: type: object properties: line_item: $ref: '#/components/schemas/v1LineItem' description: UpdateLineItemResponse response. Returns the updated line item. required: - line_item additionalProperties: true publicUpdateMFAConfigurationResponse: type: object properties: mfa_config: $ref: '#/components/schemas/v1MFAConfig' description: UpdateMFAConfiguration response. required: - mfa_config additionalProperties: true publicUpdateManagedCampaignsBulkRequestCampaignParams: type: object properties: id: type: string description: The id of the campaign. Must be left unset for the campaign creation request. Must be set for the other requests. title: type: string description: A descriptive name of the campaign. hidden: type: boolean description: 'if this value is true, it means that a campaign is no longer visible and has been archived. Only disabled or ended campaigns could be hidden. Optional(Default: False).' ad_type: $ref: '#/components/schemas/rmpcommonAdType' schedule: $ref: '#/components/schemas/rmpcommonTimeInterval' daily_budget: $ref: '#/components/schemas/rmpcommonMoneyMicro' budget: $ref: '#/components/schemas/rmpcommonBudget' targeting: $ref: '#/components/schemas/v1Targeting' goal: $ref: '#/components/schemas/managementv1CampaignGoal' catalog_item_ids: type: array items: type: string description: List of catalog items belonging to the campaign. A catalog item id can be a product id or deal id in the catalogs. Note that an item can belong to multiple campaigns. enabling_state: $ref: '#/components/schemas/commonCampaignEnablingState' assets: type: array items: $ref: '#/components/schemas/publicUpdateManagedCampaignsBulkRequestCampaignParamsAssetParams' description: Assets information for the brand campaign. landing_pages: type: array items: $ref: '#/components/schemas/publicUpdateManagedCampaignsBulkRequestCampaignParamsCampaignLandingPageParams' description: Landing pages information for the brand campaign. updated_at: type: string format: date-time description: This field represents the last time the campaign was modified. The system sets this value internally for you when you create or update a campaign, so make sure this value matches the latest updated_at you received from the ReadCampaign API. description: List of params required to create a campaign. required: - schedule - ad_type - goal - catalog_item_ids - enabling_state - updated_at additionalProperties: true publicUpdateManagedCampaignsBulkRequestCampaignParamsAssetParams: type: object properties: banner: $ref: '#/components/schemas/commonAssetBanner' logo: $ref: '#/components/schemas/commonAssetLogo' headline: $ref: '#/components/schemas/commonAssetHeadline' custom_text: $ref: '#/components/schemas/commonAssetCustomText' cta: $ref: '#/components/schemas/commonAssetCallToAction' description: Detailed settings for the campaign asset. additionalProperties: true publicUpdateManagedCampaignsBulkRequestCampaignParamsCampaignLandingPageParams: type: object properties: type: $ref: '#/components/schemas/CampaignLandingPageCampaignLandingPageType' custom_url_setting: $ref: '#/components/schemas/CampaignLandingPageCustomUrlSetting' product_detail_setting: $ref: '#/components/schemas/commonCampaignLandingPageProductDetailSetting' product_list_setting: $ref: '#/components/schemas/CampaignLandingPageProductListSetting' description: Detailed settings for the landing page. required: - type additionalProperties: true publicUpdateManagedCampaignsBulkResponse: type: object properties: campaigns: type: array items: $ref: '#/components/schemas/v1Campaign' description: Campaigns info required: - campaigns additionalProperties: true publicUpdateNotificationPreferencesWithTokenResponse: type: object description: UpdateNotificationPreferencesWithToken response additionalProperties: true publicUpdateOffsiteCampaignEnablingStateResponse: type: object properties: offsite_campaign: $ref: '#/components/schemas/v1OffsiteCampaign' required: - offsite_campaign additionalProperties: true publicUpdateOffsiteCampaignRequestOffsiteCampaignParams: type: object properties: title: type: string description: Updated descriptive name. Optional — set only when changing. channel_settings: type: array items: $ref: '#/components/schemas/v1OffsiteChannelSetting' description: Updated channel settings. Only google_setting.budget.amount is mutable in M1; all other channel-setting fields are rejected by the service layer. archived: type: boolean description: Set to true to archive the campaign (one-way). archived=false on an archived campaign is rejected. updated_at: type: string format: date-time description: Optimistic-concurrency token. MUST match the most recent updated_at returned by ReadOffsiteCampaign. The service rejects mismatched values with ABORTED. description: 'Editable fields the seller may change. The service layer rejects any attempt to change non-editable parts (channel, GoogleCampaignType, goal, product selection, schedule, account IDs, resource names, execution state). enabling_state is updated via the separate UpdateOffsiteCampaignEnablingState RPC.' required: - updated_at additionalProperties: true publicUpdateOffsiteCampaignResponse: type: object properties: offsite_campaign: $ref: '#/components/schemas/v1OffsiteCampaign' required: - offsite_campaign additionalProperties: true publicUpdatePasswordResponse: type: object description: UpdatePassword response. additionalProperties: true publicUpdatePlatformSSOSecretResponse: type: object properties: sso_secret: type: string description: Raw string of SSO secret. description: UpdatePlatformSSOSecret response required: - sso_secret additionalProperties: true publicUpdatePredefinedAudienceAccessBulkRequestAdAccountAccessUpdate: type: object properties: ad_account_id: type: string description: Identifier of the ad account. access: $ref: '#/components/schemas/v1AudienceAccessType' additionalProperties: true publicUpdatePredefinedAudienceAccessBulkRequestLabelValueAccessUpdate: type: object properties: label_value_id: type: string description: Identifier of the label value. access: $ref: '#/components/schemas/v1LabelValueAccessType' additionalProperties: true publicUpdatePredefinedAudienceAccessBulkResponse: type: object additionalProperties: true publicUpdatePredefinedAudienceAdAccountAccessBulkRequestUpdate: type: object properties: ad_account_id: type: string description: Identifier of the ad account. access: $ref: '#/components/schemas/v1AudienceAccessType' additionalProperties: true publicUpdatePredefinedAudienceAdAccountAccessBulkResponse: type: object additionalProperties: true publicUpdatePredefinedAudienceAdAccountAccessResponse: type: object additionalProperties: true publicUpdatePredefinedAudienceVisibilityBulkRequestUpdate: type: object properties: audience_id: type: string description: Identifier of the audience. visibility: $ref: '#/components/schemas/v1AudienceVisibilityType' required: - audience_id - visibility additionalProperties: true publicUpdatePredefinedAudienceVisibilityBulkResponse: type: object additionalProperties: true publicUpdatePredefinedAudienceVisibilityResponse: type: object additionalProperties: true publicUpdateSpendCapCampaignAssignmentResponse: type: object properties: campaign_ids: type: array items: type: string description: Manually selected campaign ids after the assignment update. effective_from: type: string format: date-time description: Timestamp from which the assignment update becomes effective. additionalProperties: true publicUpdateSpendCapResponse: type: object properties: spend_cap: $ref: '#/components/schemas/v1SpendCap' additionalProperties: true publicUpdateSpendingLimitResponse: type: object properties: spending_limit: $ref: '#/components/schemas/v1SpendingLimit' description: UpdateSpendingLimit response. required: - spending_limit additionalProperties: true publicUpdateUserRequestUserParams: type: object properties: name: type: string description: The name of the User. If this field is not set, a parsed email will be used. roles: type: array items: $ref: '#/components/schemas/managementv1Role' description: The roles that are granted to the User. updated_at: type: string format: date-time description: Updated timestamp. Set internally during creation, but required during update. required: - updated_at additionalProperties: true publicUpdateUserResponse: type: object properties: user: $ref: '#/components/schemas/v1User' description: UpdateUser response required: - user additionalProperties: true publicUpdateWebhookEndpointRequestWebhookEndpointParams: type: object properties: url: type: string description: The HTTPS URL that deliveries are POSTed to. description: type: string description: Human-readable description of the endpoint. Optional. subscribed_events: type: array items: $ref: '#/components/schemas/v1WebhookEvent' description: The webhook events this endpoint is subscribed to. enabled: type: boolean description: Whether the endpoint is enabled. Disabled endpoints do not receive deliveries. retry_policy: $ref: '#/components/schemas/v1WebhookRetryPolicy' updated_at: type: string format: date-time description: 'Optimistic-lock token: the updated_at last read. A mismatch fails with FailedPrecondition.' name: type: string description: Human-readable display name of the endpoint. Optional. description: 'Editable params for a full-replacement update. updated_at is the optimistic-lock token (the value last read); id / created_at are server-managed and are not accepted here.' required: - url - subscribed_events - enabled - updated_at additionalProperties: true publicUpdateWebhookEndpointResponse: type: object properties: webhook_endpoint: $ref: '#/components/schemas/v1WebhookEndpoint' description: UpdateWebhookEndpoint response. required: - webhook_endpoint additionalProperties: true publicUpsertOrderWithLineItemsRequestLineItemParams: type: object properties: id: type: string description: The id of the line item. If present, the line item will be updated; if absent, a new line item will be created. title: type: string description: A descriptive name of the line item. inventory_id: type: string description: The id of the inventory that this line item targets. Immutable. schedule: $ref: '#/components/schemas/commonOptionalTimeInterval' goal: $ref: '#/components/schemas/v1LineItemGoal' enabling_state: $ref: '#/components/schemas/commonCampaignEnablingState' priority: type: integer format: int64 description: Priority of the line item. The lower the number, the higher the priority. Valid values are 1-10. assets: type: array items: $ref: '#/components/schemas/commonAsset' description: Assets associated with the line item. Between 1 and 10 assets are allowed. landing_pages: type: array items: $ref: '#/components/schemas/commonCampaignLandingPage' description: Landing page associated with the line item. Only single landing page is allowed. updated_at: type: string format: date-time description: Updated timestamp. Required when update request. frequency_cappings: type: array items: $ref: '#/components/schemas/v1FrequencyCapping' description: Frequency capping configuration to limit impressions per user. ad_schedule: $ref: '#/components/schemas/commonAdSchedule' pacing: $ref: '#/components/schemas/v1Pacing' targeting: $ref: '#/components/schemas/v1Targeting' description: List of params required to upsert a line item. required: - title - enabling_state additionalProperties: true publicUpsertOrderWithLineItemsResponse: type: object properties: order: $ref: '#/components/schemas/v1Order' line_items: type: array items: $ref: '#/components/schemas/v1LineItem' description: List of created or updated line items associated with the order. description: UpsertOrderWithLineItems response. Returns the created or updated order along with its associated line items. required: - order - line_items additionalProperties: true publicUserDataDeletionResponse: type: object additionalProperties: true publicValidateAdAccountsBulkResponse: type: object properties: invalid_ad_accounts: type: array items: $ref: '#/components/schemas/ValidateAdAccountsBulkResponseAdAccountValidationResult' description: List of invalid ad accounts. valid_ad_accounts: type: array items: $ref: '#/components/schemas/ValidateAdAccountsBulkResponseAdAccountValidationResult' description: List of valid ad accounts. description: ValidateAdAccountsBulk response. required: - invalid_ad_accounts - valid_ad_accounts additionalProperties: true publicVerifyMFACodeResponse: type: object properties: token: type: string description: The token to be used for accessing MCM service. user: $ref: '#/components/schemas/v1User' expires_at: type: string format: date-time description: Expiration time of the token. RFC3339 format. trusted_device_pruned: type: boolean description: Whether an old trusted device was pruned due to exceeding the maximum device limit. description: VerifyMFACode response. required: - token - user - expires_at additionalProperties: true publicVerifyMFAEnrollmentResponse: type: object properties: token: type: string description: The token to be used for accessing MCM service. recovery_codes: type: array items: type: string description: List of recovery codes for MFA. user: $ref: '#/components/schemas/v1User' expires_at: type: string format: date-time description: Expiration time of the token. RFC3339 format. description: VerifyMFAEnrollment response. required: - token - recovery_codes - user - expires_at additionalProperties: true publicWallets: type: object properties: wallets: type: array items: $ref: '#/components/schemas/v1Wallet' description: List of Wallets. description: QueryWallets response. required: - wallets additionalProperties: true publicWithdrawCreditResponse: type: object properties: credit: $ref: '#/components/schemas/v1Credit' description: WithdrawCredit response. additionalProperties: true publicWithdrawWalletResponse: type: object properties: wallet: $ref: '#/components/schemas/v1Wallet' description: WithdrawWallet response. additionalProperties: true rmpNotificationCategory: type: string enum: - UNKNOWN_NOTIFICATION_CATEGORY - DEMAND_AGENT_NEW_CAMPAIGN_RECOMMENDATIONS - DEMAND_AGENT_EXISTING_CAMPAIGN_RECOMMENDATIONS - DEMAND_AGENT_COMPETITIVE_INSIGHTS default: UNKNOWN_NOTIFICATION_CATEGORY rmpcommonAdType: type: string enum: - UNKNOWN_AD_TYPE - ITEM - BRAND - DISPLAY - RESERVED_DISPLAY default: UNKNOWN_AD_TYPE rmpcommonBudget: type: object properties: period: $ref: '#/components/schemas/rmpcommonBudgetPeriod' amount: $ref: '#/components/schemas/rmpcommonMoneyMicro' description: Budget describes the amount of budget to be consumed during the designated period. required: - period - amount additionalProperties: true rmpcommonBudgetPeriod: type: string enum: - UNKNOWN_PERIOD - DAILY - WEEKLY default: UNKNOWN_PERIOD rmpcommonCampaignGoalType: type: string enum: - UNKNOWN_TYPE - FIXED_CPC - OPTIMIZE_ROAS - FIXED_COMMISSION_RATE - FIXED_CPM - MAXIMIZE_SALES default: UNKNOWN_TYPE description: "CampaignGoalType enumerates available goal types of campaign, which is Immutable.\n\n - FIXED_CPC: Goal\ \ type for the campaigns should be set to OptimizeFixedCpc message as setting value.\n - OPTIMIZE_ROAS: Goal type\ \ for the campaigns should be set to OptimizeRoas message as setting value.\n - FIXED_COMMISSION_RATE: Goal type for\ \ the campaigns should be set to OptimizeFixedCommissionRate message as setting value.\n - FIXED_CPM: Goal type for\ \ the campaigns should be set to OptimizeFixedCpm message as setting value.\n - MAXIMIZE_SALES: Goal type for the\ \ campaigns should have MaximizeSales message as setting value." rmpcommonCurrency: type: string enum: - UNKNOWN_CURRENCY - USD - KRW - JPY - EUR - GBP - SEK - INR - THB - IDR - CNY - CAD - RUB - BRL - SGD - HKD - AUD - PLN - DKK - VND - MYR - PHP - TRY - VES - AED - CHF default: UNKNOWN_CURRENCY description: "Currency enumerates available currencies.\n\n - UNKNOWN_CURRENCY: Unknown currency.\n - USD: US Dollar.\n\ \ - KRW: Korean Won.\n - JPY: Japanese Yen.\n - EUR: EU Euro.\n - GBP: British Pound.\n - SEK: Swedish Krona.\n -\ \ INR: India Rupee.\n - THB: Thailand Baht.\n - IDR: Indonesia Rupiah.\n - CNY: China Yuan.\n - CAD: Canada Dollar.\n\ \ - RUB: Russia Ruble.\n - BRL: Brazil Real.\n - SGD: Singapore Dollar.\n - HKD: Hong Kong Dollar.\n - AUD: Autrailia\ \ Dollar.\n - PLN: Poland Zloty.\n - DKK: Denmark Krone.\n - VND: Viet Nam Dong.\n - MYR: Malaysia Ringgit.\n - PHP:\ \ Philippines Peso.\n - TRY: Turkey Lira.\n - VES: Venezuela Bolívar Soberano.\n - AED: United Arab Emirates Dirham.\n\ \ - CHF: Swiss Franc." rmpcommonDayOfWeek: type: string enum: - UNKNOWN_DAY_OF_WEEK - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY - SUNDAY default: UNKNOWN_DAY_OF_WEEK description: "DayOfWeek represents the day of the week.\n\n - MONDAY: Monday\n - TUESDAY: Tuesday\n - WEDNESDAY: Wednesday\n\ \ - THURSDAY: Thursday\n - FRIDAY: Friday\n - SATURDAY: Saturday\n - SUNDAY: Sunday" rmpcommonDayPart: type: object properties: day_of_week: $ref: '#/components/schemas/rmpcommonDayOfWeek' start_time: $ref: '#/components/schemas/rmpcommonTimeOfDay' end_time: $ref: '#/components/schemas/rmpcommonTimeOfDay' description: Timeframe of a specific day of the week. required: - day_of_week - start_time - end_time additionalProperties: true rmpcommonDimension: type: object properties: width: type: integer format: int64 description: The width of the dimension. Required. height: type: integer format: int64 description: The height of the dimension. Required. required: - width - height additionalProperties: true rmpcommonFloatingPointRange: type: object properties: start: type: number format: double description: The start of the floating point range. end: type: number format: double description: The end of the floating point range description: A range of floating point. required: - start - end additionalProperties: true rmpcommonImageAssetType: type: string enum: - UNKNOWN_IMAGE_ASSET_TYPE - BANNER - LOGO default: UNKNOWN_IMAGE_ASSET_TYPE description: ImageAssetType enumerates available image asset types. rmpcommonMediaType: type: string enum: - UNKNOWN_MEDIA_TYPE - IMAGE - VIDEO default: UNKNOWN_MEDIA_TYPE rmpcommonMicroRange: type: object properties: min: type: string format: int64 description: Min amount in micro unit. max: type: string format: int64 description: Max amount in micro unit. description: MicroRange defines the min and max values allowed [min, max] in micro unit. required: - min - max additionalProperties: true rmpcommonMoney: type: object properties: currency: $ref: '#/components/schemas/rmpcommonCurrency' amount: type: number format: double description: Amount of money. (e.g., 12.34) description: "A monetary amount in a specific currency.\nFor example, `{currency: \"USD\", amount: 12.34}` means $12.34.\ \ \nPrice of the single item." required: - currency - amount additionalProperties: true rmpcommonMoneyMicro: type: object properties: currency: $ref: '#/components/schemas/rmpcommonCurrency' amount_micro: type: string format: int64 description: Amount in micro unit. (e.g., 1234 means 0.001234) description: 'A monetary amount in a specific currency; the unit is micro at fixed point value for accurate accumulation operation. For example, `{"currency": "USD", "amount_micro": "1234"}` means $0.001234.' required: - currency - amount_micro additionalProperties: true rmpcommonOrderByColumn: type: string enum: - UNKNOWN_ORDER_BY - ID - TITLE - PRICE - SALE_PRICE - CATEGORY - REVIEW_COUNT - RATING_SCORE - ACTIVE default: UNKNOWN_ORDER_BY rmpcommonTimeInterval: 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: 'Campaign''s interval with start and end timestamps in RFC3339 format. The Campaign will conceptually run during [schedule_start, schedule_end] inclusively. It is highly recommended that schedule.start is set to UTC corresponding to the beginning of the day (00:00:00), and schedule.end is set to UTC corresponding to the end of the day (23:59:59) both in the ad account''s timezone. If you want to set no end date, make sure your platform supports no end date setting and just leave schedule_end blank.' required: - start additionalProperties: true rmpcommonTimeOfDay: type: object properties: hours: type: integer format: int32 description: 'Hours of day in 24 hour format. Should be from 0 to 24. An API may choose to allow the value "24:00:00" for scenarios like business closing time.' description: Specific time of the day. required: - hours additionalProperties: true rmpcommonUInt32Range: type: object properties: min: type: integer format: int64 description: The min of range. max: type: integer format: int64 description: The max of range. description: A range of integer. required: - min - max additionalProperties: true rmpcommonZone: type: string enum: - UNKNOWN_ZONE - SEOUL - FRANKFURT - MUMBAI - SINGAPORE - ASHBURN - DALLES - SYDNEY - TOKYO default: UNKNOWN_ZONE description: Zones supported for RMP services. v1AcceptUserJoinBulkRequestInfo: type: object properties: ad_account_id: type: string description: AdAccount id. user_join_request_id: type: string description: UserJoinRequest id. role: $ref: '#/components/schemas/managementv1Role' description: AcceptUserJoinBulkRequest information required: - ad_account_id - user_join_request_id additionalProperties: true v1AcceptUserJoinRequestInfo: type: object properties: role: $ref: '#/components/schemas/managementv1Role' description: AcceptUserJoinRequest information additionalProperties: true v1Account: type: object properties: type: $ref: '#/components/schemas/commonAccountType' balance: $ref: '#/components/schemas/rmpcommonMoneyMicro' additionalProperties: true v1AccountUpdateAmount: type: object properties: type: $ref: '#/components/schemas/commonAccountType' amount: $ref: '#/components/schemas/rmpcommonMoneyMicro' additionalProperties: true v1AdAccountAccessType: type: string enum: - UNKNOWN_TYPE - ACCESSIBLE - INACCESSIBLE default: UNKNOWN_TYPE v1AdAccountItemListing: type: object properties: ad_account_id: type: string ad_account_title: type: string item_id: type: string region: type: string availability: $ref: '#/components/schemas/commonCatalogItemAvailability' price_micro: type: string format: int64 sale_price_micro: type: string format: int64 currency: type: string active: type: boolean created_timestamp: type: string format: date-time custom_label_0: type: string price_seller_micro: type: string format: int64 sale_price_seller_micro: type: string format: int64 currency_seller: type: string additionalProperties: true v1AdAccountOverview: type: object properties: id: type: string description: The id of the AdAccount. title: type: string description: A descriptive name of the AdAccount. description: Definition of a AdAccountOverview. readOnly: true required: - id - title additionalProperties: true v1AdAccountStateInfo: type: object properties: ad_account_id: type: string description: The id of the AdAccount. state: $ref: '#/components/schemas/v1AdAccountStateInfoAdAccountState' state_case: $ref: '#/components/schemas/AdAccountStateInfoStateCase' state_updated_at: type: string format: date-time description: Timestamp for when the AdAccount's state was updated. readOnly: true updated_at: type: string format: date-time description: Updated timestamp. Set internally during creation, but required during update. This should match the updated timestamp updated_at of the ad account, which is able to check with ReadAdAccount API. description: AdAccountStateInfo encloses AdAccount's state information. required: - ad_account_id - state - state_case - state_updated_at - updated_at additionalProperties: true v1AdAccountStateInfoAdAccountState: type: string enum: - UNKNOWN_STATE - ACTIVE - INACTIVE default: UNKNOWN_STATE v1AdAccountSummaryGroupByColumn: type: string enum: - UNKNOWN_GROUP_BY - DATE - AD_ACCOUNT - CURRENCY - CAMPAIGN - ITEM - INVENTORY_ID - CREATIVE - ASSET default: UNKNOWN_GROUP_BY description: ' - UNKNOWN_GROUP_BY: This value is not part of the API specification.' v1AdAccountSummaryOrderByColumn: type: string enum: - UNKNOWN_ORDER_BY - TIME_DATE - TIME_DATE_DESC - TIMEZONE - TIMEZONE_DESC - CURRENCY_DIM - CURRENCY_DIM_DESC - AD_ACCOUNT_ID - AD_ACCOUNT_ID_DESC - AD_ACCOUNT_TITLE - AD_ACCOUNT_TITLE_DESC - CATALOG_ITEM_TITLE - CATALOG_ITEM_TITLE_DESC - CAMPAIGN_ID - CAMPAIGN_ID_DESC - CAMPAIGN_TITLE - CAMPAIGN_TITLE_DESC - CATALOG_ITEM_ID - CATALOG_ITEM_ID_DESC - INVENTORY_DIM - INVENTORY_DIM_DESC - CREATIVE_ID - CREATIVE_ID_DESC - CREATIVE_TITLE - CREATIVE_TITLE_DESC - IMP_COUNT - IMP_COUNT_DESC - CLICK_COUNT - CLICK_COUNT_DESC - MONEY_SPENT - MONEY_SPENT_DESC - PURCHASE_COUNT - PURCHASE_COUNT_DESC - REVENUE - REVENUE_DESC - ROAS - ROAS_DESC - CPC - CPC_DESC - CR - CR_DESC - CTR - CTR_DESC - IMP_TO_PURCHASE - IMP_TO_PURCHASE_DESC - NUM_AD_ACCOUNTS - NUM_AD_ACCOUNTS_DESC - ITEMS_PER_AD_ACCOUNT - ITEMS_PER_AD_ACCOUNT_DESC - ACOS - ACOS_DESC - CPM - CPM_DESC default: UNKNOWN_ORDER_BY title: "- UNKNOWN_ORDER_BY: This value is not part of the API specification.\n - IMP_COUNT: Metrics" v1AdAccountSummaryRow: type: object properties: date: type: string description: Date in 'YYYY-MM-DD'. timezone: type: string description: Timezone of date in the data. currency: type: string description: Currency. ad_account_id: type: string description: Ad account id. ad_account_title: type: string description: Ad account title. campaign_id: type: string description: Campaign id. campaign_title: type: string description: Campaign title. catalog_item_id: type: string description: Catalog item id. catalog_item_title: type: string description: Catalog item title. creative_id: type: string description: Creative id. creative_title: type: string description: Creative title. asset_id: type: string description: Asset id. inventory_id: type: string description: Inventory id. imp_count: type: string format: int64 description: Impression count. imp_item_count: type: string format: int64 description: Per item impression count. Only populated for item-level group by results with Sponsored Brand campaign. click_count: type: string format: int64 description: Click count. money_spent: type: string format: int64 description: Money spent. It is in a micro unit. purchase_count: type: string format: int64 description: Purchase count. purchase_breakdown: $ref: '#/components/schemas/commonHaloMetricInt' revenue: type: string format: int64 description: Money earned. It is in a micro unit. revenue_breakdown: $ref: '#/components/schemas/commonHaloMetricInt' roas: type: number format: double description: ROAS in percent. roas_breakdown: $ref: '#/components/schemas/commonHaloMetricDouble' cr: type: number format: double description: CR. Click to Purchase rate. ctr: type: number format: double description: CTR. Click divided by Impressions. ctr_item: type: number format: double description: CTR per item-level impression. Click divided by imp_item_count, in percent. Only populated for item-level group by results with Sponsored Brand campaign. imp_to_purchase: type: number format: double description: CTR multiplied by CR (CTR x CR). imp_item_to_purchase: type: number format: double description: Purchase rate per item-level impression. Purchase divided by imp_item_count, in percent. Only populated for item-level group by results with Sponsored Brand campaign. num_ad_accounts: type: string format: int64 description: Number of active ad accounts during selected time period (platform summary specific). items_per_ad_account: type: number format: double description: Items per ad account (platform summary specific). cpc: type: number format: double description: CPC (Cost Per Click) in a micro unit. acos: type: number format: double description: Advertising cost of sales in percent. Ad Spending / Revenue cpm: type: number format: double description: CPM (Cost Per 1,000 Impressions) in a micro unit. cpm_item: type: number format: double description: CPM per item-level impression in a micro unit. Money spent divided by imp_item_count, multiplied by 1,000. Only populated for item-level group by results with Sponsored Brand campaign. description: AdAccountSummaryRow represents a row of ad-account-level summarized reporting. additionalProperties: true v1AdAccountUser: type: object properties: ad_account_id: type: string description: The id for the Ad Account that the Ad Account User is registered. id: type: string description: The id of the Ad Account User. Set internally during creation. email: type: string description: The email of the Ad Account User, Immutable. name: type: string description: The name of the Ad Account User. If this field is not set, a parsed email will be used. role: $ref: '#/components/schemas/v1RoleName' status: $ref: '#/components/schemas/v1RegistrationStatus' created_at: type: string format: date-time description: Created timestamp. API user should not touch this field; it is set internally. readOnly: true updated_at: type: string format: date-time description: Updated timestamp. Set internally during creation, but required during update. description: Definition of a AdAccountUser. required: - ad_account_id - id - email - role - status - created_at - updated_at additionalProperties: true v1AdAccountUserAccessChangeLog: type: object properties: activity: $ref: '#/components/schemas/UserAccessChangeLogActivity' platform_id: type: string description: Indicates the identifier of the platform. ad_account_id: type: string description: Indicates the identifier of the ad account. ad_account_title: type: string description: Indicates the descriptive name of the ad account. user_id: type: string description: The id of the target user. user_email: type: string description: The email of the target user. user_name: type: string description: The descriptive name of the target user. user_role_before: $ref: '#/components/schemas/v1RoleName' user_role_after: $ref: '#/components/schemas/v1RoleName' reason: type: string description: The rejection reason of the target user. changed_by: $ref: '#/components/schemas/v1ChangeLogUser' updated_at: type: string format: date-time description: Updated timestamp of the entity. description: Definition of a AdAccountUserAccessChangeLog. required: - activity - platform_id - ad_account_id - ad_account_title - user_id - user_email - user_name - user_role_before - user_role_after - reason - updated_at additionalProperties: true v1AdManagerAccount: type: object properties: id: type: string description: The id of the ad manager account. readOnly: true title: type: string description: The title of the ad manager account. managing_type: $ref: '#/components/schemas/v1AdManagerAccountManagingType' managing_ad_account_ids: type: array items: type: string description: The list of managing ad account id of the ad manager account. created_at: type: string format: date-time description: The created time of the ad manager account. readOnly: true updated_at: type: string format: date-time description: The updated time of the ad manager account. readOnly: true description: Definition of an ad manager account. required: - id - title - managing_type - created_at - updated_at additionalProperties: true v1AdManagerAccountManagingType: type: string enum: - UNKNOWN_MANAGING_TYPE - OWNER default: UNKNOWN_MANAGING_TYPE v1AdManagerAccountReportSummaryGroupByColumn: type: string enum: - UNKNOWN_GROUP_BY - DATE - AD_ACCOUNT - CURRENCY default: UNKNOWN_GROUP_BY v1AdManagerAccountSummaryRow: type: object properties: date: type: string description: Date in 'YYYY-MM-DD'. timezone: type: string description: Timezone of date in the data. currency: type: string description: Currency. ad_account_id: type: string description: Ad account id. ad_account_title: type: string description: Ad account title. imp_count: type: string format: int64 description: Impression count. click_count: type: string format: int64 description: Click count. money_spent: type: string format: int64 description: Money spent. It is in a micro unit. purchase_count: type: string format: int64 description: Purchase count. purchase_breakdown: $ref: '#/components/schemas/commonHaloMetricInt' revenue: type: string format: int64 description: Money earned. It is in a micro unit. revenue_breakdown: $ref: '#/components/schemas/commonHaloMetricInt' roas: type: number format: double description: ROAS in percent. roas_breakdown: $ref: '#/components/schemas/commonHaloMetricDouble' cr: type: number format: double description: CR. Click to Purchase rate. ctr: type: number format: double description: CTR. Click divided by Impressions. cpc: type: number format: double description: CPC (Cost Per Click) in a micro unit. cpm: type: number format: double description: CPM (Cost Per 1,000 Impressions) in a micro unit. description: AdManagerAccountSummaryRow represents a row of summarized reporting of ad manager account. additionalProperties: true v1AdManagerAccountUser: type: object properties: ad_manager_account_id: type: string description: The id for the Ad Manager Account that the Ad Manager Account User is registered. id: type: string description: The id of the Ad Manager Account User. Set internally during creation. readOnly: true email: type: string description: The email of the Ad Manager Account User, Immutable. name: type: string description: The name of the Ad Manager Account User. If this field is not set, a parsed email will be used. role: $ref: '#/components/schemas/v1RoleName' status: $ref: '#/components/schemas/v1RegistrationStatus' created_at: type: string format: date-time description: Created timestamp. API user should not touch this field; it is set internally. readOnly: true updated_at: type: string format: date-time description: Updated timestamp. Set internally during creation, but required during update. readOnly: true description: Definition of a AdManagerAccountUser. required: - id - ad_manager_account_id - email - role - created_at - updated_at additionalProperties: true v1AdManagerAccountUserAccessChangeLog: type: object properties: activity: $ref: '#/components/schemas/UserAccessChangeLogActivity' platform_id: type: string description: Indicates the identifier of the platform. ad_manager_account_id: type: string description: Indicates the identifier of the ad manager account. ad_manager_account_title: type: string description: Indicates the descriptive name of the ad manager account. user_id: type: string description: The id of the target user. user_email: type: string description: The email of the target user. user_name: type: string description: The descriptive name of the target user. user_role_before: $ref: '#/components/schemas/v1RoleName' user_role_after: $ref: '#/components/schemas/v1RoleName' reason: type: string description: The rejection reason of the target user. changed_by: $ref: '#/components/schemas/v1ChangeLogUser' updated_at: type: string format: date-time description: Updated timestamp of the entity. description: Definition of a AdManagerAccountUserAccessChangeLog. required: - activity - platform_id - ad_manager_account_id - ad_manager_account_title - user_id - user_email - user_name - user_role_before - user_role_after - reason - updated_at additionalProperties: true v1AssetEntityDetail: type: object properties: id: type: string description: Asset ID. review_status: $ref: '#/components/schemas/commonReviewStatus' use_status: $ref: '#/components/schemas/v1AssetEntityDetailUseStatus' metadata: $ref: '#/components/schemas/v1AssetMetadata' title: Asset Detail additionalProperties: true v1AssetEntityDetailUseStatus: type: string enum: - UNKNOWN_USE_STATUS - ACTIVE - INACTIVE default: UNKNOWN_USE_STATUS v1AssetMetadata: type: object properties: banner: $ref: '#/components/schemas/v1AssetMetadataBanner' logo: $ref: '#/components/schemas/v1AssetMetadataLogo' headline: $ref: '#/components/schemas/v1AssetMetadataHeadline' cta: $ref: '#/components/schemas/v1AssetMetadataCallToAction' custom_text: $ref: '#/components/schemas/v1AssetMetadataCustomText' additionalProperties: true v1AssetMetadataBanner: type: object properties: media_type: $ref: '#/components/schemas/rmpcommonMediaType' media_url: type: string additionalProperties: true v1AssetMetadataCallToAction: type: object properties: text: type: string additionalProperties: true v1AssetMetadataCustomText: type: object properties: text: type: string additionalProperties: true v1AssetMetadataHeadline: type: object properties: text: type: string additionalProperties: true v1AssetMetadataLogo: type: object properties: image_url: type: string additionalProperties: true v1AudienceAccessType: type: string enum: - UNKNOWN_TYPE - ACCESSIBLE - INACCESSIBLE default: UNKNOWN_TYPE v1AudienceReportSummaryRow: type: object properties: campaign_id: type: string description: Campaign id. campaign_title: type: string description: Campaign title. audience: type: string description: Audience. It is audience label if the audience_type is 'CUSTOM'. imp_count: type: string format: int64 description: Impression count. click_count: type: string format: int64 description: Click count. ctr: type: number format: double description: CTR. Click divided by Impressions. purchase_count: type: string format: int64 description: Purchase count captured by direct and indirect attribution. revenue: type: string format: int64 description: Money earned captured by direct and indirect attribution. It is in a micro unit. cpc: type: number format: double description: CPC (Cost Per Click) in a micro unit. money_spent: type: string format: int64 description: Money spent. It is in a micro unit. roas: type: number format: double description: ROAS captured by direct and indirect attribution, in percent. description: AudienceReportSummaryRow represents a row of summarized reporting of audiences. additionalProperties: true v1AudienceVisibilityType: type: string enum: - UNKNOWN_TYPE - PUBLIC - RESTRICTED default: UNKNOWN_TYPE v1BrandContent: type: object properties: id: type: string description: The id of the brand. name: type: string description: The name of the brand. appearances: type: integer format: int64 description: The number of appearances of the brand. valid: type: boolean description: The validity of the brand. description: Definition of a brand content. required: - id - name - appearances - valid additionalProperties: true v1Campaign: type: object properties: id: type: string description: The id of the campaign. Must be left unset for the campaign creation request. Must be set for the other requests. title: type: string description: A descriptive name of the campaign. ad_account_id: type: string description: The id of the ad account that owns this campaign. It is platform-specific ad_account_id. Value and format can vary according to each Platform. hidden: type: boolean description: 'if this value is true, it means that a campaign is no longer visible and has been archived. Only disabled or ended campaigns could be hidden. Optional(Default: False).' ad_type: $ref: '#/components/schemas/rmpcommonAdType' schedule: $ref: '#/components/schemas/rmpcommonTimeInterval' daily_budget: $ref: '#/components/schemas/rmpcommonMoneyMicro' budget: $ref: '#/components/schemas/rmpcommonBudget' targeting: $ref: '#/components/schemas/v1Targeting' goal: $ref: '#/components/schemas/managementv1CampaignGoal' catalog_item_ids: type: array items: type: string description: List of catalog items belonging to the campaign. A catalog item id can be a product id or deal id in the catalogs. Note that an item can belong to multiple campaigns. enabling_state: $ref: '#/components/schemas/commonCampaignEnablingState' state: $ref: '#/components/schemas/CampaignCampaignState' created_at: type: string format: date-time description: Created timestamp. API user should not touch this field; it is set internally. readOnly: true updated_at: type: string format: date-time description: This field represents the last time the campaign was modified. The system sets this value internally for you when you create or update a campaign, so make sure this value matches the latest updated_at you received from the ReadCampaign API. item_selection: $ref: '#/components/schemas/CampaignCampaignItemSelection' assets: type: array items: $ref: '#/components/schemas/commonAsset' description: Assets for the campaign. It contains all assets that would be used in the campaign. For the ad serving, only latest approved asset for each dimension would be used. landing_pages: type: array items: $ref: '#/components/schemas/commonCampaignLandingPage' description: Landing pages for the campaign. It contains all landing pages that would be used in the campaign. For the ad serving, only latest approved landing page would be used. spend_cap_id: type: string description: The id of the spend cap that applies to this campaign. Available for SELF_SERVED performance-based sponsored ads campaigns on platforms with Spend Cap enabled. Once set, it cannot be changed. ad_operation_type: $ref: '#/components/schemas/campaignAdOperationType' alias: type: string description: The alias is the platform-defined identifier for the campaign. description: Definition of a campaign. required: - ad_account_id - schedule - ad_type - goal - catalog_item_ids - enabling_state - created_at additionalProperties: true v1CampaignChangeLogItem: type: object properties: id: type: string description: The id of the CampaignChangeLogItem. title: type: string description: The title of the CampaignChangeLogItem. description: Definition of a CampaignChangeLogItem. required: - id - title additionalProperties: true v1CampaignEntityChangeLog: type: object properties: method: $ref: '#/components/schemas/EntityChangeLogEntityChangeMethod' entity_id: type: string description: The id of the entity. field_type: $ref: '#/components/schemas/EntityChangeLogFieldType' field_name: type: string description: The name of the field. The nested field will have '.' as a separator. e.g. A.B.C represents the hierarchy, meaning top-level field is A, and the field C is under the field B below it. field_before: type: string description: Field value before the change. This field will be filled except for the case of item change. field_after: type: string description: Field value after the change. This field will be filled except for the case of item change. removed_items_count: type: integer format: int64 description: The number of items that existed in the campaign and then disappeared. This field will be filled only for the case of item change. added_items_count: type: integer format: int64 description: The number of items newly added that were not in the campaign. This field will be filled only for the case of item change. updated_at: type: string format: date-time description: Updated timestamp of the campaign entity. changed_by: $ref: '#/components/schemas/v1ChangeLogUser' description: Definition of a CampaignEntityChangeLog. required: - method - entity_id - field_type - field_name - updated_at additionalProperties: true v1CampaignEntityMetrics: type: object properties: imp_count: type: string format: int64 description: Impression count. click_count: type: string format: int64 description: Click count. money_spent_micro: type: string format: int64 description: Money spent. It is in a micro unit. purchase_breakdown: $ref: '#/components/schemas/commonHaloMetricInt' revenue_breakdown: $ref: '#/components/schemas/commonHaloMetricInt' ctr: type: number format: double description: CTR. Click divided by Impressions. cpc: type: number format: double description: CPC (Cost Per Click) in a micro unit. roas_breakdown: $ref: '#/components/schemas/commonHaloMetricDouble' cr_breakdown: $ref: '#/components/schemas/commonHaloMetricDouble' cpm: type: number format: double description: CPM (Cost Per 1,000 Impressions) in a micro unit. title: Metrics additionalProperties: true v1CampaignHomeResource: type: object properties: item: $ref: '#/components/schemas/v1ItemEntityDetail' report: $ref: '#/components/schemas/v1CampaignHomeResourceReport' description: CampaignHomeResource represents a resource that contains the information of the campaign home. readOnly: true additionalProperties: true v1CampaignHomeResourceReport: type: object properties: currency: type: string description: Currency. audience_type: type: string description: Audience type. It can be either ONSITE or OFFSITE. imp_count: type: string format: int64 description: Impression count. click_count: type: string format: int64 description: Click count. ctr: type: number format: double description: CTR. Click divided by Impressions. money_spent: type: string format: int64 description: Money spent. It is in a micro unit. cpm: type: number format: double description: CPM (Cost Per 1,000 Impressions) in a micro unit. cpc: type: number format: double description: CPC (Cost Per Click) in a micro unit. total_purchase_count: type: string format: int64 description: Total purchase counts captured by direct + indirect attribution. direct_purchase_count: type: string format: int64 description: Purchase counts captured by direct attribution. indirect_purchase_count: type: string format: int64 description: Purchase counts captured by indirect attribution. total_revenue: type: string format: int64 description: Total money earned captured by direct + indirect attribution. It is in a micro unit. direct_revenue: type: string format: int64 description: Money earned captured by direct attribution. It is in a micro unit. indirect_revenue: type: string format: int64 description: Money earned captured by indirect attribution. It is in a micro unit. total_roas: type: number format: double description: Total ROAS captured by direct + indirect attribution. It is in a percent. direct_roas: type: number format: double description: ROAS captured by direct attribution. It is in a percent. indirect_roas: type: number format: double description: ROAS captured by indirect attribution. It is in a percent. cr: type: number format: double description: CR. Click to Purchase rate. total_acos: type: number format: double description: Total ACOS captured by direct + indirect attribution. It is in a percent. direct_acos: type: number format: double description: ACOS captured by direct attribution. It is in a percent. indirect_acos: type: number format: double description: ACOS captured by indirect attribution. It is in a percent. additionalProperties: true v1CampaignHomeResourceRow: type: object properties: item: $ref: '#/components/schemas/v1ItemEntityDetail' asset: $ref: '#/components/schemas/v1AssetEntityDetail' report: $ref: '#/components/schemas/v1CampaignEntityMetrics' description: ReportSummaryRow represents a row of summarized reporting of a campaign ad detail. additionalProperties: true v1CampaignOverview: type: object properties: id: type: string description: The id of the Campaign. title: type: string description: A descriptive name of the Campaign. schedule: $ref: '#/components/schemas/rmpcommonTimeInterval' description: Definition of a CampaignOverview. readOnly: true required: - id - title - schedule additionalProperties: true v1CampaignRecommendation: type: object properties: id: type: string description: The id of the CampaignRecommendation. UUID, auto-generated on Create. recommendation_id: type: string description: Unique recommendation key from QE Surface Engine. Used as an idempotency key. ad_account_id: type: string description: The id of the AdAccount that owns this recommendation. status: $ref: '#/components/schemas/CampaignRecommendationCampaignRecommendationStatus' campaign: $ref: '#/components/schemas/v1Campaign' recommendation_reason: type: string description: Human-readable recommendation reason, in platform locale. expired_at: type: string format: date-time description: Expiration timestamp. Computed as created_at + recommendation_ttl_days. created_at: type: string format: date-time description: Created timestamp. updated_at: type: string format: date-time description: Updated timestamp. trigger_type: $ref: '#/components/schemas/CampaignRecommendationCampaignRecommendationTriggerType' recommendation_type: $ref: '#/components/schemas/CampaignRecommendationCampaignRecommendationType' description: Definition of CampaignRecommendation. additionalProperties: true v1CampaignResourceGroupByColumn: type: string enum: - UNKNOWN_GROUP_BY - ITEM - ASSET default: UNKNOWN_GROUP_BY description: ' - UNKNOWN_GROUP_BY: This value is not part of the API specification.' v1CampaignReview: type: object properties: ad_account_id: type: string description: The id of the ad account that owns this campaign review. It is platform-specific ad account id. Value and format can vary according to each Platform. campaign_id: type: string description: The id of the campaign that owns this campaign review. brand_entity_type: $ref: '#/components/schemas/commonBrandEntityType' brand_entity_id: type: string description: Brand entity id of the review. It must be asset id or landing page id. review_status: $ref: '#/components/schemas/commonReviewStatus' rejection_reason: type: string description: If the review status is rejected, this field must contain the reason for rejection. created_at: type: string format: date-time description: Created timestamp. This field is automatically set during the creation process and should not be modified by the API user. readOnly: true updated_at: type: string format: date-time description: This field represents the last time the campaign review was modified. The system sets this value internally for you when you create or update a campaign review, so make sure this value matches the latest updated_at you received the campaign review. description: Definition of a campaign review. required: - ad_account_id - campaign_id - brand_entity_type - brand_entity_id additionalProperties: true v1CampaignReviewQueueRow: type: object properties: id: type: string description: Campaign id. title: type: string description: Campaign title. ad_account_id: type: string description: Ad account id. ad_account_title: type: string description: Ad account title. Falls back to ad_account_id when title is missing. ad_type: $ref: '#/components/schemas/rmpcommonAdType' created_at: type: string format: date-time description: Campaign creation timestamp. readOnly: true in_review_count: type: integer format: int64 description: Count of IN_REVIEW review rows. approved_count: type: integer format: int64 description: Count of APPROVED review rows. rejected_count: type: integer format: int64 description: Count of REJECTED review rows. description: A campaign row in the review queue. required: - id - title - ad_account_id - ad_account_title - ad_type - created_at - in_review_count - approved_count - rejected_count additionalProperties: true v1CampaignSpendCapAssignment: type: object properties: assignment_id: type: string description: Stable identifier of the assignment record. Omitted for legacy-derived assignments. spend_cap_id: type: string description: Spend Cap id. purpose: $ref: '#/components/schemas/SpendCapPurpose' campaign_assignment_scope: $ref: '#/components/schemas/SpendCapCampaignAssignmentScope' effective_from: type: string format: date-time description: Timestamp from which this assignment becomes effective. Omitted for legacy-derived assignments. effective_to: type: string format: date-time description: Timestamp until which this assignment is effective. Omitted for open-ended or legacy-derived assignments. additionalProperties: true v1CampaignUpsertOption: type: object properties: include_all: type: boolean description: If set to true, add all items of the AdAccount to the campaign. In this case, catalog item ids in request will be ignored. Supported only for SELF_SERVED campaigns excluded_item_ids: type: array items: type: string description: List of item ids which will be excluded when creating or updating the campaign. Note that this option will be applied only if `include_all` field is set to true. The maximum number of excluded item ids is 5000. description: CampaignUpsertOption describes the option when campaign is created or updated. additionalProperties: true v1CampaignedCreative: type: object properties: creative: $ref: '#/components/schemas/v1Creative' campaign_id: type: string description: The id of the campaign that references the creative. readOnly: true use_status: $ref: '#/components/schemas/managementv1UseStatus' added_at: type: string format: date-time description: Creative's added timestamp in the campaign. It is set internally. readOnly: true description: Definition of a campaigned creative. required: - creative - campaign_id - use_status - added_at additionalProperties: true v1CatalogHistory: type: object properties: dag_id: type: string description: The DAG ID. dag_run_id: type: string description: The DAG run ID. catalog_update_type: $ref: '#/components/schemas/CatalogDagHistoryCatalogUpdateType' status: $ref: '#/components/schemas/v1CatalogHistoryStatus' validation_metrics: $ref: '#/components/schemas/CatalogHistoryValidationMetrics' validation_completed_at: type: string format: date-time description: When validation completed. pipeline_completed_at: type: string format: date-time description: When entire pipeline completed. started_at: type: string format: date-time description: When the run started. validation_report_exists: type: boolean description: Whether the validation report file exists. ad_account_items_validation_metrics: $ref: '#/components/schemas/CatalogHistoryValidationMetrics' ad_account_items_validation_report_exists: type: boolean description: Whether the ad account items validation report file exists (MSPI only). additionalProperties: true v1CatalogHistoryStatus: type: string enum: - UNKNOWN_STATUS - VALIDATING - VALIDATION_FAILED - PROCESSING - PROCESSING_FAILED - SUCCESS - INCOMPLETE default: UNKNOWN_STATUS description: ' - INCOMPLETE: INCOMPLETE indicates the run did not complete within the expected time (24h).' v1CatalogItem: type: object properties: id: type: string description: Item ID, unique within the catalog. title: type: string description: Item title. image_link: type: string description: URL to the item's primary image. link: type: string description: URL to the item's product page. categories: type: array items: $ref: '#/components/schemas/v1CatalogItemCategoryPath' description: Structured category paths for the item. Supports multiple category assignments. brand: type: string description: Brand name. brand_id: type: string description: Brand ID. gtin: type: string description: Global trade item number (GTIN). item_group_id: type: string description: Group identifier shared by variants of the same item. custom_label_0: type: string description: Catalog feed custom label 0. review_count: type: string format: int64 description: Number of reviews. rating_score: type: number format: double description: Average rating score. availability: $ref: '#/components/schemas/commonCatalogItemAvailability' created_timestamp: type: string format: date-time description: When the item was first ingested into the catalog. additionalProperties: true v1CatalogItemCategoryPath: type: object properties: levels: type: array items: type: string description: Hierarchical category levels, e.g., ["Apparel", "Footwear", "Sneakers"]. additionalProperties: true v1CategoryContent: type: object properties: path: type: string description: The full path of the category. path_list: type: array items: type: string description: The list of the path of the category. name: type: string description: The name of the deepest category. appearances: type: integer format: int64 description: The number of appearances of the category. valid: type: boolean description: The validity of the category. description: Definition of a category content. required: - path - path_list - name - appearances - valid additionalProperties: true v1CategoryNode: type: object properties: path: type: string description: The full path of the category. path_list: type: array items: type: string description: The list of the path of the category. name: type: string description: The name of deepest the category. appearances: type: integer format: int64 description: The number of appearances of the category. num_of_children: type: integer format: int64 description: The number of children of the category. children: type: array items: $ref: '#/components/schemas/v1CategoryNode' description: The list of children of the category. description: Definition of a category node. required: - path - path_list - name - appearances - num_of_children additionalProperties: true v1ChangeLogItemsOrderBy: type: object properties: column: $ref: '#/components/schemas/v1ChangeLogItemsOrderByOrderByColumn' direction: $ref: '#/components/schemas/commonOrderByDirection' additionalProperties: true v1ChangeLogItemsOrderByOrderByColumn: type: string enum: - UNKNOWN_ORDER_BY_COLUMN - ID - TITLE - UPDATED_AT default: UNKNOWN_ORDER_BY_COLUMN v1ChangeLogItemsType: type: string enum: - UNKNOWN_TYPE - REMOVED - ADDED default: UNKNOWN_TYPE v1ChangeLogOrderBy: type: object properties: column: $ref: '#/components/schemas/v1ChangeLogOrderByOrderByColumn' direction: $ref: '#/components/schemas/commonOrderByDirection' additionalProperties: true v1ChangeLogOrderByOrderByColumn: type: string enum: - UNKNOWN_ORDER_BY_COLUMN - UPDATED_AT default: UNKNOWN_ORDER_BY_COLUMN v1ChangeLogUser: type: object properties: id: type: string description: The id of the Change Log User. name: type: string description: The name of the Change Log User. email: type: string description: The email of the Change Log User. role: $ref: '#/components/schemas/v1RoleName' description: Definition of a ChangeLogUser. additionalProperties: true v1Channel: type: string enum: - UNKNOWN_CHANNEL - EMAIL - WEBHOOK default: UNKNOWN_CHANNEL v1CptSummaryRow: type: object properties: date: type: string description: Date. ad_account_id: type: string description: Ad Account ID. ad_account_title: type: string description: Ad Account Name. campaign_id: type: string description: Campaign ID. campaign_title: type: string description: Campaign Name. inventory_id: type: string description: Inventory ID. sub_inventory: type: string description: Sub-intenvory. imp_count: type: string format: int64 description: Impression count. click_count: type: string format: int64 description: Click count. cost: $ref: '#/components/schemas/rmpcommonMoneyMicro' schedule: $ref: '#/components/schemas/CptSummaryRowSchedule' description: CptSummaryRow represents a row of summarized reporting of managed cpt. additionalProperties: true v1Creative: type: object properties: id: type: string description: The id of the creative. Must be left unset for the creative creation request. Must be set for the other requests. title: type: string description: A descriptive name of the creative. ad_account_id: type: string description: The id of the ad account that owns this creative. It is platform-specific ad_account_id. Value and format can vary according to each Platform. type: $ref: '#/components/schemas/v1CreativeType' image_source: $ref: '#/components/schemas/v1ImageSource' review_status: $ref: '#/components/schemas/v1CreativeReviewStatus' created_at: type: string format: date-time description: Created timestamp. API user should not touch this field; it is set internally. readOnly: true updated_at: type: string format: date-time description: Updated timestamp. Set internally during creation, but required during update. This should match the updated timestamp updated_at of the creative, which is able to check with ReadCreative API. description: Definition of a creative. required: - ad_account_id - type - created_at additionalProperties: true v1CreativeAgentLoopMeta: type: object properties: session_id: type: string description: FE-generated identifier that groups all CA calls in one session. campaign_id: type: string description: Set when editing the creative of an existing campaign. description: Caller identity carried on the agent-loop RPC body. Mgmtsvc forwards it to creativesvc, where it scopes stored assets and joins cost capture and event tracking across BQ rows. required: - session_id additionalProperties: true v1CreativeAgentMeta: type: object properties: session_id: type: string description: FE-generated identifier that groups all CA calls in one session. catalog_item_id: type: string description: Identifier of the catalog item being worked on. campaign_id: type: string description: Set when editing the creative of an existing campaign. description: Caller identity carried on every CA RPC body. Mgmtsvc fills these from the Portal request so cost capture, event tracking, and campaign-creative marking can join across BQ rows. Creativesvc validates the shape and forwards unchanged. required: - session_id - catalog_item_id additionalProperties: true v1CreativeAgentResponseMeta: type: object properties: generation_id: type: string description: Identifier of the upstream LLM call that served this request. description: Per-call meta returned alongside every CA response. Carries the upstream generation id so mgmtsvc and BQ can trace the LLM call that served the request. required: - generation_id additionalProperties: true v1CreativeOverview: type: object properties: id: type: string description: The id of the Creative. ad_account: $ref: '#/components/schemas/v1AdAccountOverview' campaigns: type: array items: $ref: '#/components/schemas/v1CampaignOverview' description: The overview of Campaigns. description: Definition of a CreativeOverview. readOnly: true required: - id - ad_account - campaigns additionalProperties: true v1CreativeReviewStatus: type: object properties: status: $ref: '#/components/schemas/v1CreativeStatus' rejection_reason: type: string description: Rejection reason when creative is rejected. required when the status is rejected. updated_at: type: string format: date-time description: Updated timestamp. Set internally during creation, but required during update. This should match the updated timestamp updated_at of the creative, which is able to check with ReadCreative API. description: Detailed information of the creative review status. required: - status - updated_at additionalProperties: true v1CreativeStatus: type: string enum: - UNKNOWN_CREATIVE_STATUS - IN_REVIEW - APPROVED - REJECTED default: UNKNOWN_CREATIVE_STATUS title: enum type for creative's status v1CreativeType: type: string enum: - UNKNOWN_CREATIVE_TYPE - IMAGE default: UNKNOWN_CREATIVE_TYPE v1Credit: type: object properties: id: type: string description: The id of the Credit. Must be left unset for the Credit creation request. Must be set for the other requests. title: type: string description: A friendly name for the credit. ad_account_id: type: string description: The id of the AdAccount for this credit. balance: $ref: '#/components/schemas/rmpcommonMoneyMicro' created_at: type: string format: date-time description: Created timestamp. API user should not touch this field; it is set internally. readOnly: true updated_at: type: string format: date-time description: Updated timestamp. Set internally during creation, but required during update. description: Definition of a Credit. required: - id - ad_account_id - balance - created_at - updated_at additionalProperties: true v1CreditAccountHistoryLog: type: object properties: type: $ref: '#/components/schemas/v1CreditAccountHistoryLogType' budget_change: $ref: '#/components/schemas/v1CreditAccountHistoryLogMoneyMicroByAccount' balance: $ref: '#/components/schemas/v1CreditAccountHistoryLogMoneyMicroByAccount' updated_at: type: string format: date-time description: Updated timestamp of wallet. metadata: $ref: '#/components/schemas/v1CreditAccountHistoryLogMetadata' changed_by: $ref: '#/components/schemas/v1CreditAccountHistoryLogChangedBy' description: Definition of a WalletAccountHistoryLog. required: - type - budget_change - balance - updated_at additionalProperties: true v1CreditAccountHistoryLogChangedBy: type: object properties: id: type: string name: type: string email: type: string role: $ref: '#/components/schemas/v1RoleName' additionalProperties: true v1CreditAccountHistoryLogMetadata: type: object properties: comment: type: string description: A comment for transaction. Optional. additionalProperties: true v1CreditAccountHistoryLogMoneyMicroByAccount: type: object properties: credits: $ref: '#/components/schemas/rmpcommonMoneyMicro' additionalProperties: true v1CreditAccountHistoryLogType: type: string enum: - UNKNOWN_TYPE - FUNDED - REFUNDED - SPENT default: UNKNOWN_TYPE v1CustomTargetKey: type: object properties: id: type: string description: The id of the custom target key. label: type: string description: The label of the custom target key. description: type: string description: The description of the custom target key. is_multi_select: type: boolean description: Whether the custom target key allows multi select. valid: type: boolean description: The validity of the custom target key. readOnly: true created_at: type: string format: date-time description: Created timestamp. API user should not touch this field; it is set internally. readOnly: true updated_at: type: string format: date-time description: Updated timestamp. Set internally during creation, but required during update. This should match the updated timestamp updated_at of the custom target key. readOnly: true description: Definition of a custom target key. required: - id - label - description - is_multi_select - valid - created_at - updated_at additionalProperties: true v1CustomTargetValue: type: object properties: id: type: string description: The id of the custom target value. custom_target_key_id: type: string description: The id of the custom target key to which this value belongs. label: type: string description: The label of the custom target value. valid: type: boolean description: The validity of the custom target value. readOnly: true created_at: type: string format: date-time description: Created timestamp. API user should not touch this field; it is set internally. readOnly: true updated_at: type: string format: date-time description: Updated timestamp. Set internally during creation, but required during update. This should match the updated timestamp updated_at of the custom target value. readOnly: true description: Definition of a custom target value. required: - id - custom_target_key_id - label - valid - created_at - updated_at additionalProperties: true v1DailyLineItemResource: type: object properties: line_item: $ref: '#/components/schemas/v1LineItem' reports: type: array items: $ref: '#/components/schemas/v1DailyLineItemResourceReport' description: Daily report data for the line item. additionalProperties: true v1DailyLineItemResourceReport: type: object properties: date: type: string description: Date of the report in YYYY-MM-DD format. imp_count: type: string format: int64 description: Impression count for the date. additionalProperties: true v1DenyUserJoinBulkRequestInfo: type: object properties: ad_account_id: type: string description: AdAccount id. user_join_request_id: type: string description: UserJoinRequest id. reason: type: string description: Reason of deny. description: DenyUserJoinBulkRequest information required: - ad_account_id - user_join_request_id - reason additionalProperties: true v1DenyUserJoinRequestInfo: type: object properties: reason: type: string description: Reason of deny. description: DenyUserJoinRequest information required: - reason additionalProperties: true v1EntityChangeLog: type: object properties: method: $ref: '#/components/schemas/EntityChangeLogEntityChangeMethod' entity_id: type: string description: The id of the entity. field_type: $ref: '#/components/schemas/EntityChangeLogFieldType' field_name: type: string description: The name of the field. field_before: type: string description: Field value before the change. field_after: type: string description: Field value after the change. updated_at: type: string format: date-time description: Updated timestamp of the entity. changed_by: $ref: '#/components/schemas/v1ChangeLogUser' description: Definition of a EntityChangeLog. required: - method - entity_id - field_type - field_name - field_before - field_after - updated_at additionalProperties: true v1EntityChangeLogFilter: type: object properties: method: $ref: '#/components/schemas/EntityChangeLogEntityChangeMethod' field_name: type: string description: The name of the changed field. description: Definition of a ChangeLogFilter. The fields in the message compose AND condition filter. additionalProperties: true v1EntityLevel: type: string enum: - PLATFORM - AD_ACCOUNT - BOTH default: PLATFORM v1EntityVisibilityType: type: string enum: - UNKNOWN_TYPE - PUBLIC - RESTRICTED default: UNKNOWN_TYPE v1FrequencyCapping: type: object properties: max_impressions: type: integer format: int64 description: Maximum number of impressions per user. Must be greater than 0. reset_period: $ref: '#/components/schemas/FrequencyCappingResetPeriod' description: Configuration for frequency capping on a per-user-per-line item basis. required: - max_impressions - reset_period additionalProperties: true v1GoogleCampaignType: type: string enum: - GOOGLE_CAMPAIGN_TYPE_UNKNOWN - GOOGLE_CAMPAIGN_TYPE_PERFORMANCE_MAX default: GOOGLE_CAMPAIGN_TYPE_UNKNOWN description: 'GoogleCampaignType is the Google Ads campaign type that a Google offsite setting or execution represents. M1 supports PERFORMANCE_MAX only.' v1GoogleGoalSetting: type: object properties: pmax_goal_setting: $ref: '#/components/schemas/v1GooglePMaxGoalSetting' description: GoogleGoalSetting selects the campaign-type-specific goal setting message. additionalProperties: true v1GooglePMaxGoalSetting: type: object properties: type: $ref: '#/components/schemas/v1GooglePMaxGoalSettingType' maximize_conversion_value: $ref: '#/components/schemas/GooglePMaxGoalSettingMaximizeConversionValue' description: 'GooglePMaxGoalSetting models PMax-specific goal configuration. Modeled after CampaignGoal: type plus oneof setting that the type selects. M1: MAXIMIZE_CONVERSION_VALUE only (with optional target ROAS as a sub-option). TARGET_ROAS and TARGET_CPA are distinct Google Ads bidding strategies and are reserved here until needed.' additionalProperties: true v1GooglePMaxGoalSettingType: type: string enum: - UNKNOWN_TYPE - MAXIMIZE_CONVERSION_VALUE default: UNKNOWN_TYPE v1GooglePMaxProductSelection: type: object properties: type: $ref: '#/components/schemas/v1GooglePMaxProductSelectionType' description: 'GooglePMaxProductSelection models which products from the seller MC sub-account feed participate in PMax serving. M1 only supports ALL_ELIGIBLE_PRODUCTS.' additionalProperties: true v1GooglePMaxProductSelectionType: type: string enum: - UNKNOWN_TYPE - ALL_ELIGIBLE_PRODUCTS default: UNKNOWN_TYPE v1GooglePMaxSetting: type: object properties: product_selection: $ref: '#/components/schemas/v1GooglePMaxProductSelection' description: 'GooglePMaxSetting carries non-goal PMax-specific requested intent. The remarketing AssetGroupSignal is sourced from Platform.offsite_campaign_config.google_offsite_campaign_config.audience_user_list_resource_name and is NOT exposed on the seller-facing Portal proto (Google resource names must not leak into the seller surface).' additionalProperties: true v1GoogleSetting: type: object properties: campaign_type: $ref: '#/components/schemas/v1GoogleCampaignType' budget: $ref: '#/components/schemas/rmpcommonBudget' schedule: $ref: '#/components/schemas/rmpcommonTimeInterval' goal_setting: $ref: '#/components/schemas/v1GoogleGoalSetting' pmax_setting: $ref: '#/components/schemas/v1GooglePMaxSetting' description: 'GoogleSetting carries Google-common requested intent. Budget, schedule, and goal live here so multi-campaign-type support can layer on without restructuring.' additionalProperties: true v1ImageAsset: type: object properties: id: type: string description: The id of the image asset. Must be left unset for the image asset creation request. Must be set for the other requests. ad_account_id: type: string description: The id of the ad account that owns this image asset. It is platform-specific ad_account_id. Value and format can vary according to each Platform. image_asset_type: $ref: '#/components/schemas/rmpcommonImageAssetType' title: type: string description: A descriptive name of the image asset. image_source: $ref: '#/components/schemas/v1ImageSource' created_at: type: string format: date-time description: Created timestamp. API user should not touch this field; it is set internally in creation process. readOnly: true description: ImageAsset that could be used for the campaign's asset. required: - ad_account_id - image_asset_type additionalProperties: true v1ImageSource: type: object properties: url: type: string description: The URL of the image. width: type: integer format: int64 description: The width of the image. readOnly: true height: type: integer format: int64 description: The height of the image. readOnly: true size: type: integer format: int64 description: The file size in bytes of the image. readOnly: true file_name: type: string description: The file name of the image. description: Detailed information of an image. required: - url - width - height - size - file_name additionalProperties: true v1InventoryDecisionType: type: string enum: - UNKNOWN_DECISION_TYPE - RECOMMENDATION - AUCTION - CREATIVE_AUCTION default: UNKNOWN_DECISION_TYPE v1InventoryMonitoringMetric: type: object properties: window_start: type: string format: date-time description: Inclusive start timestamp of the metric bucket. window_end: type: string format: date-time description: Exclusive end timestamp of the metric bucket. ad_requests: type: string format: int64 description: Number of ad requests in the bucket. impressions: type: string format: int64 description: Number of impressions in the bucket. clicks: type: string format: int64 description: Number of clicks in the bucket. description: InventoryMonitoringMetric row. required: - window_start - window_end - ad_requests - impressions - clicks additionalProperties: true v1InventoryReportSummaryRow: type: object properties: campaign_id: type: string description: Campaign id. campaign_title: type: string description: Campaign title. placement: type: string description: Placement that the inventory belongs to. It can be a placement name, such as HOME, SEARCH, CART, etc. inventory: type: string description: Inventory name (title). Resolved from the inventory entity; empty if the inventory is not found. imp_count: type: string format: int64 description: Impression count. click_count: type: string format: int64 description: Click count. ctr: type: number format: double description: CTR. Click divided by Impressions. cpc: type: number format: double description: CPC (Cost Per Click) in a micro unit. money_spent: type: string format: int64 description: Money spent. It is in a micro unit. description: InventoryReportSummaryRow represents a row of summarized reporting of inventories. additionalProperties: true v1ItemEntityDetail: type: object properties: id: type: string title: type: string gtin: type: string custom_label_0: type: string listing_status: $ref: '#/components/schemas/v1ListingStatus' title: Item Detail additionalProperties: true v1ItemSearchResultRow: type: object properties: id: type: string description: Id of Item. title: type: string description: Title of Item. price: $ref: '#/components/schemas/rmpcommonMoney' sale_price: $ref: '#/components/schemas/rmpcommonMoney' link: type: string description: Link of Item. image_link: type: string description: Image link of Item. category: type: string description: 'DEPRECATED: Use categories field instead. Category of Item in old format with dedicated delimiters.' review_count: type: string format: int64 description: Review count of Item. rating_score: type: number format: float description: Rating of Item. is_active: type: boolean description: Activeness of Item. is_new: type: boolean description: Whether an Item is new. created_timestamp: type: string format: date-time description: Created timestamp of Item. gtin: type: string description: GTIN categories: type: array items: $ref: '#/components/schemas/v1ItemSearchResultRowCategoryPath' description: Structured category paths for the item. Supports multiple category assignments. brand: type: string description: Brand name of the item. brand_id: type: string description: Brand ID of the item. price_seller: $ref: '#/components/schemas/rmpcommonMoney' sale_price_seller: $ref: '#/components/schemas/rmpcommonMoney' description: ItemSearchResultRow represents a row of item search results. additionalProperties: true v1ItemSearchResultRowCategoryPath: type: object properties: levels: type: array items: type: string description: Hierarchical category levels, e.g., ["Esport", "Ciclisme", "Shoes"] additionalProperties: true v1ItemStatus: type: object properties: item_id: type: string description: The id of the item. seller_id: type: string description: The id of the seller. Only applicable for MSPI catalogs. If this value is provided, only the item associated with the specified seller ID will be removed from ad serving. If not provided, the specified item will be removed for all sellers in MSPI. updated_time: type: string format: date-time description: The time when the item was updated. The Catalog feed batch Ingestion and Kill Switch API can operate simultaneously. When multiple data sources are available, the most recent information is retrieved based on the item's updated_time. blocked: type: string description: The reason the item is blocked (e.g., “out_of_stock”). This field is required and cannot be left empty. description: The status of the item to be updated. required: - item_id - updated_time - blocked additionalProperties: true v1KeywordReportSummaryRow: type: object properties: campaign_id: type: string description: Campaign id. campaign_title: type: string description: Campaign title. keyword: type: string description: Individual target keyword setup in the campaign. match_type: type: string description: Match type of the keyword. search_term_count_total: type: string format: int64 description: Search term total count. opportunity_count: type: string format: int64 description: Deprecated. Opportunity Count. imp_count: type: string format: int64 description: Impression count. click_count: type: string format: int64 description: Click count. ctr: type: number format: double description: CTR. Click divided by Impressions. money_spent: type: string format: int64 description: Money spent. It is in a micro unit. purchase_count: type: string format: int64 description: Purchase count captured by direct and indirect attribution. revenue: type: string format: int64 description: Revenue captured by direct and indirect attribution. It is in a micro unit. cpc: type: number format: double description: CPC (Cost Per Click) in a micro unit. roas: type: number format: double description: ROAS captured by direct and indirect attribution, in percent. description: KeywordReportSummaryRow represents a row of summarized reporting of campaigned keywords. additionalProperties: true v1LabelValue: type: object properties: id: type: string description: The id of the value. This is a rmp-side truth. Thus it is always required, even for CreateValueRequest. label_id: type: string description: Label ID that this value belongs to. Required. name: type: string description: A descriptive name of the value. Required. created_at: type: string format: date-time description: Created timestamp. API user should not touch this field; it is set internally. readOnly: true updated_at: type: string format: date-time description: Updated timestamp. Set internally during creation, but required during update. This should match the updated timestamp updated_at of the value, which is able to check with ReadValue API. readOnly: true description: Definition of a label value. required: - id - label_id - name - created_at - updated_at additionalProperties: true v1LabelValueAccessType: type: string enum: - UNKNOWN_TYPE - ACCESSIBLE - INACCESSIBLE default: UNKNOWN_TYPE v1LandingUrl: type: object properties: id: type: string description: The id of the landing url. Must be left unset for the landing url creation request. Must be set for the other requests. title: type: string description: A descriptive name of the landing url. ad_account_id: type: string description: The id of the ad account that owns this landing url. It is platform-specific ad_account_id. Value and format can vary according to each Platform. url: type: string description: URL of this landing url. review_status: $ref: '#/components/schemas/v1LandingUrlReviewStatus' created_at: type: string format: date-time description: Created timestamp. API user should not touch this field; it is set internally. readOnly: true updated_at: type: string format: date-time description: Updated timestamp. Set internally during creation, but required during update. This should match the updated timestamp updated_at of the landing url, which is able to check with ReadLandingUrl API. description: Definition of a landing url. required: - ad_account_id - url additionalProperties: true v1LandingUrlReviewStatus: type: object properties: status: $ref: '#/components/schemas/LandingUrlReviewStatusLandingUrlStatus' rejection_reason: type: string description: Rejection reason when landing url is rejected. required when the status is rejected. updated_at: type: string format: date-time description: Updated timestamp. Set internally during creation, but required during update. This should match the updated timestamp updated_at of the landing url, which is able to check with ReadLandingUrl API. description: Detailed information of the landing url review status. required: - status - updated_at additionalProperties: true v1LifeTimeLineItemResource: type: object properties: line_item: $ref: '#/components/schemas/v1LineItem' report: $ref: '#/components/schemas/v1LifeTimeLineItemResourceReport' additionalProperties: true v1LifeTimeLineItemResourceReport: type: object properties: imp_count: type: string format: int64 description: Impression count for the line item. reach: type: string format: int64 description: Reach for the line item. frequency: type: number format: double description: Frequency for the line item. ctr: type: number format: double description: Click-through rate for the line item. additionalProperties: true v1LineItem: type: object properties: id: type: string description: The id of the line item. title: type: string description: A descriptive name of the line item. order_id: type: string description: The id of the order that contains this line item. inventory_id: type: string description: The id of the inventory that this line item targets. schedule: $ref: '#/components/schemas/commonOptionalTimeInterval' goal: $ref: '#/components/schemas/v1LineItemGoal' enabling_state: $ref: '#/components/schemas/commonCampaignEnablingState' priority: type: integer format: int64 description: Priority of the line item. The lower the number, the higher the priority. Valid values are 1-10. assets: type: array items: $ref: '#/components/schemas/commonAsset' description: Assets associated with the line item. Only single asset is allowed. landing_pages: type: array items: $ref: '#/components/schemas/commonCampaignLandingPage' description: Landing pages associated with the line item. Only single landing page is allowed. created_at: type: string format: date-time description: Created timestamp. It is set internally. readOnly: true updated_at: type: string format: date-time description: Updated timestamp. It is set internally. readOnly: true frequency_cappings: type: array items: $ref: '#/components/schemas/v1FrequencyCapping' description: Frequency capping configuration to limit impressions per user. pacing: $ref: '#/components/schemas/v1Pacing' description: Definition of a line item. required: - id - title - order_id - enabling_state - assets - landing_pages - created_at - updated_at additionalProperties: true v1LineItemDailyCustomReportRow: type: object properties: custom_target_key_id: type: string description: The id of the custom target key. custom_target_value_id: type: string description: The id of the custom target value. custom_target_value_label: type: string description: The label of the custom target value. imp_count: type: string format: int64 description: Impression count for the date. ctr: type: number format: double description: Click-through rate for the date. additionalProperties: true v1LineItemDailyReportRow: type: object properties: date: type: string description: Date of the report in YYYY-MM-DD format. imp_count: type: string format: int64 description: Impression count for the date. reach: type: string format: int64 description: Reach for the date. frequency: type: number format: double description: Frequency for the date. ctr: type: number format: double description: Click-through rate for the date. click_count: type: string format: int64 description: Click count for the date. additionalProperties: true v1LineItemGoal: type: object properties: type: $ref: '#/components/schemas/commonLineItemGoalType' reserved_impressions: $ref: '#/components/schemas/LineItemGoalReservedImpressions' reserved_time: $ref: '#/components/schemas/LineItemGoalReservedTime' additionalProperties: true v1LineItemSummary: type: object properties: line_item: $ref: '#/components/schemas/v1LineItem' report: $ref: '#/components/schemas/v1LineItemSummaryReport' additionalProperties: true v1LineItemSummaryReport: type: object properties: imp_count: type: string format: int64 description: Impression count for the line item. reach: type: string format: int64 description: Reach for the line item. frequency: type: number format: double description: Frequency for the line item. ctr: type: number format: double description: Click-through rate for the line item. oti: type: number format: double description: On-target indicator for the line item. additionalProperties: true v1ListingStatus: type: string enum: - UNKNOWN_LISTING_STATUS - LISTED - NOT_LISTED default: UNKNOWN_LISTING_STATUS v1MFAConfig: type: object properties: policy: $ref: '#/components/schemas/MFAConfigPolicy' remember_device_config: $ref: '#/components/schemas/managementv1RememberDeviceConfig' description: Definition of a MFAConfig. required: - policy additionalProperties: true v1MFARegistrationStatus: type: string enum: - UNKNOWN_MFA_REGISTRATION_STATUS - MFA_NOT_REGISTERED - MFA_ENROLLMENT_PENDING - MFA_REGISTERED default: UNKNOWN_MFA_REGISTRATION_STATUS v1NotificationEvent: type: string enum: - UNKNOWN_NOTIFICATION_EVENT - CUSTOM - INVITE_USER - REVOKE_USER - DELETE_USER - CHANGE_USER_ROLE - FORGOT_PASSWORD - NOTIFY_USER - ACCEPT_REQUEST_NEW_USER - ACCEPT_REQUEST_EXISTING_USER - DENY_REQUEST - NEW_DENY_REQUEST - REJECT_CREATIVE - DEACTIVATE_AD_ACCOUNT - LOW_WALLET_BALANCE - REACHED_SPENDING_LIMIT - REVOKE_AD_MANAGER_ACCOUNT_USER - CHANGE_AD_MANAGER_ACCOUNT_USER_ROLE - ACTIVATE_AD_ACCOUNT - REJECT_AD_ELEMENT - FAIL_VIDEO_TRANSCODING - DEMAND_AGENT_NEW_ITEMS - DEMAND_AGENT_CURATED_TRENDING - DEMAND_AGENT_HIGH_POTENTIAL - DEMAND_AGENT_SIMILAR_SELLERS - DEMAND_AGENT_NEW_ADVERTISERS - DEMAND_AGENT_TOP_SELLERS - DEMAND_AGENT_BU_HIGH - WEBHOOK_EVENT_CAMPAIGN_BUDGET_HIGH_UPSELL - WEBHOOK_EVENT_ADVERTISER_RE_ENGAGE_CHURNED default: UNKNOWN_NOTIFICATION_EVENT description: ' - WEBHOOK_EVENT_CAMPAIGN_BUDGET_HIGH_UPSELL: Webhook events (internal). Public-facing WebhookEvent (mgmtsvc) maps 1:1 to these; internal DEMAND_AGENT_* map N:1 here (notisvc InternalEventToWebhookEvent).' v1NotificationPreferenceUpdate: type: object properties: notification_category: $ref: '#/components/schemas/rmpNotificationCategory' notification_event: $ref: '#/components/schemas/v1NotificationEvent' channel: $ref: '#/components/schemas/v1Channel' opted_in: type: boolean description: Whether to opt in to this notification. Set true to subscribe, false to unsubscribe. description: A single notification preference update. required: - notification_category - channel - opted_in additionalProperties: true v1NotificationPreferences: type: object properties: notification_preference_setting: type: object additionalProperties: $ref: '#/components/schemas/v1NotificationPreferencesPerChannel' description: Map of channel name to notification preferences per channel. description: Notification preferences organized by channel. additionalProperties: true v1NotificationPreferencesPerChannel: type: object properties: events: type: object additionalProperties: type: boolean description: Map of notification event name to opt-in status. categories: type: object additionalProperties: type: boolean description: Map of notification category name to opt-in status. description: Notification preferences per channel. The key is the notification category name, the value is the opt-in status. additionalProperties: true v1OffsiteCampaign: type: object properties: id: type: string description: 'The id of the OffsiteCampaign. Server-assigned on create; must be unset on CreateOffsiteCampaign requests. Required on read and update.' platform_id: type: string description: The platform id that owns this OffsiteCampaign. ad_account_id: type: string description: The AdAccount id that owns this OffsiteCampaign. title: type: string description: A descriptive name. Required on create; seller-mutable. enabling_state: $ref: '#/components/schemas/OffsiteCampaignEnablingState' archived: type: boolean description: 'Whether this OffsiteCampaign is archived. One-way: unarchive is not supported. Archived campaigns are read-only.' channel_settings: type: array items: $ref: '#/components/schemas/v1OffsiteChannelSetting' description: 'Requested channel intent. M1: exactly one entry with channel = OFFSITE_CHANNEL_GOOGLE.' offsite_executions: type: array items: $ref: '#/components/schemas/v1OffsiteExecutionView' description: 'Output-only. Seller-safe execution view hydrated from OffsiteChannelExecution. Does NOT include raw Google resource names, customer IDs, or unsanitized errors. Public RPCs MUST reject this field if set on create/update requests.' created_at: type: string format: date-time description: Created timestamp. updated_at: type: string format: date-time description: 'Updated timestamp. Used as an optimistic-concurrency token on UpdateOffsiteCampaign: callers MUST echo back the value most recently returned by ReadOffsiteCampaign, and the service rejects the update if it does not match the current persisted value.' description: 'OffsiteCampaign is the Portal-facing seller-facing aggregate root for offsite campaigns. Admin-internal fields (mutation_id, Google resource names, raw Google errors) are intentionally omitted; admin RPCs return the raw OffsiteChannelExecution entity instead.' additionalProperties: true v1OffsiteChannel: type: string enum: - OFFSITE_CHANNEL_UNKNOWN - OFFSITE_CHANNEL_GOOGLE default: OFFSITE_CHANNEL_UNKNOWN description: 'OffsiteChannel identifies which external offsite channel a setting / execution / link belongs to.' v1OffsiteChannelSetting: type: object properties: channel: $ref: '#/components/schemas/v1OffsiteChannel' google_setting: $ref: '#/components/schemas/v1GoogleSetting' description: OffsiteChannelSetting carries the channel-specific seller intent for one offsite channel. additionalProperties: true v1OffsiteExecutionView: type: object properties: id: type: string offsite_campaign_id: type: string channel: $ref: '#/components/schemas/v1OffsiteChannel' provisioning_state: $ref: '#/components/schemas/v1OffsiteProvisioningState' serving_state: $ref: '#/components/schemas/v1OffsiteServingState' last_external_mutation_at: type: string format: date-time last_reconciled_at: type: string format: date-time latest_status_summary: type: string description: Sanitized human-readable summary. Does NOT contain raw Google error payloads. description: 'OffsiteExecutionView is the seller-safe projection of OffsiteChannelExecution returned by public (Portal) seller RPCs. Omits Google resource names, customer IDs, raw errors, and mutation_id.' additionalProperties: true v1OffsiteProvisioningState: type: string enum: - OFFSITE_PROVISIONING_STATE_UNKNOWN - OFFSITE_PROVISIONING_STATE_CREATING - OFFSITE_PROVISIONING_STATE_ACTIVE - OFFSITE_PROVISIONING_STATE_UPDATING - OFFSITE_PROVISIONING_STATE_SUSPENDING - OFFSITE_PROVISIONING_STATE_FAILED default: OFFSITE_PROVISIONING_STATE_UNKNOWN description: 'OffsiteProvisioningState is the mutation-side state of an OffsiteChannelExecution. In-progress values (CREATING / UPDATING / SUSPENDING) gate concurrent Google-mutating calls on the same execution.' v1OffsiteServingState: type: string enum: - OFFSITE_SERVING_STATE_UNKNOWN - OFFSITE_SERVING_STATE_NOT_SERVING - OFFSITE_SERVING_STATE_SERVING - OFFSITE_SERVING_STATE_PAUSED - OFFSITE_SERVING_STATE_SUSPENDED - OFFSITE_SERVING_STATE_REMOVED default: OFFSITE_SERVING_STATE_UNKNOWN description: 'OffsiteServingState is the observed serving state of the external (Google) campaign. Refreshed periodically by GoogleStatusSync. The seller intent (OffsiteCampaign.enabling_state) can diverge from serving_state.' v1Order: type: object properties: id: type: string description: The id of the order. title: type: string description: A descriptive name of the order. ad_account_id: type: string description: The id of the ad account that owns this order. It is platform-specific ad_account_id. Value and format can vary according to each Platform. schedule: $ref: '#/components/schemas/commonOptionalTimeInterval' budget: $ref: '#/components/schemas/commonOptionalBudget' insertion_order_url: type: string description: URL of the insertion order. state: $ref: '#/components/schemas/OrderOrderState' created_at: type: string format: date-time description: Created timestamp. It is set internally. readOnly: true updated_at: type: string format: date-time description: Updated timestamp. It is set internally. readOnly: true draft: type: boolean description: Draft indicator. If true - order is in draft state; false - order is actually launched. readOnly: true ad_payer: type: string description: Free-text identifier of the party financially responsible for line items under this order (for compliance reporting). Optional; BE-enforced 200-character limit. description: Definition of an order. required: - id - title - ad_account_id - state - created_at - updated_at additionalProperties: true v1OrderResource: type: object properties: order: $ref: '#/components/schemas/v1Order' line_item_count: type: string format: int64 description: Number of line items in the order. ad_account_title: type: string description: Title of the associated ad account. report: $ref: '#/components/schemas/v1OrderResourceReport' additionalProperties: true v1OrderResourceReport: type: object properties: imp_count: type: string format: int64 description: Impression count for the order. additionalProperties: true v1OrderSummary: type: object properties: order: $ref: '#/components/schemas/v1Order' report: $ref: '#/components/schemas/v1OrderSummaryReport' ad_account_title: type: string description: Title of the associated ad account. additionalProperties: true v1OrderSummaryReport: type: object properties: imp_count: type: string format: int64 description: Impression count for the order. ctr: type: number format: double description: Click-through rate for the order. additionalProperties: true v1Pacing: type: object properties: type: $ref: '#/components/schemas/PacingPacingType' additionalProperties: true v1ParameterList: type: object properties: path: type: string description: The application path that the SSO login request should be redirected to after login. platform_id: type: string description: A unique identifier for the retailer assigned by MOLOCO. ad_account_id: type: string description: A unique identifier for the advertiser account assigned by the retailer. ad_account_title: type: string description: The title of the advertiser account assigned by the retailer. If omitted, ad account id will be used instead. name: type: string description: The name of the advertiser user. email: type: string description: The email address of the advertiser. role: $ref: '#/components/schemas/v1ParameterListRole' external_user_id: type: string description: A unique identifier for the advertiser in the retail platform. timestamp: type: string format: int64 description: The current time in UNIX timestamp.. nonce: type: string description: A random string used as an identifier for each API call. version: type: string description: The version of the signature. description: Definition of a ParameterList. required: - platform_id - name - email - external_user_id - timestamp - nonce - version additionalProperties: true v1ParameterListRole: type: string enum: - EMPTY_ROLE - PLATFORM_USER - AD_ACCOUNT_OWNER - AD_ACCOUNT_USER - AD_ACCOUNT_AGENCY default: EMPTY_ROLE v1PlacementReportSummaryRow: type: object properties: campaign_id: type: string description: Campaign id. campaign_title: type: string description: Campaign title. placement: type: string description: Placement. It can be a placement name, such as HOME, SEARCH, CART, etc. imp_count: type: string format: int64 description: Impression count. click_count: type: string format: int64 description: Click count. ctr: type: number format: double description: CTR. Click divided by Impressions. purchase_count: type: string format: int64 description: Purchase counts captured by direct and indirect attribution. revenue: type: string format: int64 description: Money earned captured by direct and indirect attribution. It is in a micro unit. cpc: type: number format: double description: CPC (Cost Per Click) in a micro unit. money_spent: type: string format: int64 description: Money spent. It is in a micro unit. roas: type: number format: double description: ROAS captured by direct and indirect attribution, in percent. description: PlacementReportSummaryRow represents a row of summarized reporting of placements. additionalProperties: true v1PlatformDashboardResource: type: object properties: metric_type: $ref: '#/components/schemas/v1PlatformDashboardResourceMetricType' submetric_type: $ref: '#/components/schemas/PlatformDashboardResourceSubMetricType' aggr_summary: $ref: '#/components/schemas/PlatformDashboardResourceAggregationSummary' data: type: array items: $ref: '#/components/schemas/PlatformDashboardResourceMetricData' description: Metric data. status: $ref: '#/components/schemas/v1PlatformDashboardResourceStatus' description: PlatformDashboardResource represents a resource that contains the information of the platform dashboard. readOnly: true additionalProperties: true v1PlatformDashboardResourceMetricType: type: string enum: - UNKNOWN_METRIC_TYPE - AD_SPEND_BY_GMV_PERCENT - METRICS_FOR_TOP_SPENDING_ADVERTISERS - AD_ACCOUNT_ADOPTION_RATE - ITEM_ADOPTION_RATE - OVERALL_BY_CATEGORY - OVERALL_BY_INVENTORY default: UNKNOWN_METRIC_TYPE v1PlatformDashboardResourceStatus: type: string enum: - UNKNOWN - OK - NOT_AVAILABLE_DATA default: UNKNOWN description: "- OK: Values are available.\n - NOT_AVAILABLE_DATA: Requested values are unavailable.\nNote: This status\ \ is different from having empty array for the requested data.\nThis is related to requesting for date ranges that\ \ a platform does not support.\nThis status will still have 200 status code." title: Status of the response v1PlatformHomeResource: type: object properties: ad_account: $ref: '#/components/schemas/v1PlatformHomeResourceAdAccount' report: $ref: '#/components/schemas/v1PlatformHomeResourceReport' description: PlatformHomeResource represents a resource that contains the information of the platform home. readOnly: true additionalProperties: true v1PlatformHomeResourceAdAccount: type: object properties: id: type: string description: The id of the AdAccount. title: type: string description: A descriptive name of the AdAccount. state: $ref: '#/components/schemas/AdAccountState' state_case: $ref: '#/components/schemas/AdAccountStateInfoStateCase' additionalProperties: true v1PlatformHomeResourceReport: type: object properties: currency: type: string description: Currency. audience_type: type: string description: Audience type. It can be either ONSITE or OFFSITE. imp_count: type: string format: int64 description: Impression count. click_count: type: string format: int64 description: Click count. ctr: type: number format: double description: CTR. Click divided by Impressions. money_spent: type: string format: int64 description: Money spent. It is in a micro unit. cpm: type: number format: double description: CPM (Cost Per 1,000 Impressions) in a micro unit. cpc: type: number format: double description: CPC (Cost Per Click) in a micro unit. total_purchase_count: type: string format: int64 description: Total purchase counts captured by direct + indirect attribution. direct_purchase_count: type: string format: int64 description: Purchase counts captured by direct attribution. indirect_purchase_count: type: string format: int64 description: Purchase counts captured by indirect attribution. total_revenue: type: string format: int64 description: Total money earned captured by direct + indirect attribution. It is in a micro unit. direct_revenue: type: string format: int64 description: Money earned captured by direct attribution. It is in a micro unit. indirect_revenue: type: string format: int64 description: Money earned captured by indirect attribution. It is in a micro unit. total_roas: type: number format: double description: Total ROAS captured by direct + indirect attribution. It is in a percent. direct_roas: type: number format: double description: ROAS captured by direct attribution. It is in a percent. indirect_roas: type: number format: double description: ROAS captured by indirect attribution. It is in a percent. total_acos: type: number format: double description: Total ACOS captured by direct + indirect attribution. It is in a percent. direct_acos: type: number format: double description: ACOS captured by direct attribution. It is in a percent. indirect_acos: type: number format: double description: ACOS captured by indirect attribution. It is in a percent. cr: type: number format: double description: CR. Click to Purchase rate. additionalProperties: true v1PlatformInfo: type: object properties: id: type: string description: The id of the Platform. title: type: string description: A descriptive name of the Platform. logo_url: type: string description: The URL of the Platform's logo image. userspace_id: type: string description: The Userspace ID associated with the Platform. custom_client_config: type: object additionalProperties: type: string description: Custom configurations for client application. api_config: $ref: '#/components/schemas/PlatformInfoAPIConfig' description: Definition of a PlatformInfo. title: 'TODO: deprecate PlatformInfo message after migrating GetPlatformInfo endpoint to mgmt-internal (@sjhan-moloco)' required: - id - title - userspace_id - api_config additionalProperties: true v1PlatformInsightResource: type: object properties: metric_type: $ref: '#/components/schemas/v1PlatformInsightResourceMetricType' ad_accounts_wallet_running_low_metric: $ref: '#/components/schemas/PlatformInsightResourceAdAccountsWalletRunningLowMetric' ad_accounts_nearing_spending_limit_metric: $ref: '#/components/schemas/PlatformInsightResourceAdAccountsNearingSpendingLimitMetric' campaigns_expiring_soon_metric: $ref: '#/components/schemas/PlatformInsightResourceCampaignsExpiringSoonMetric' top_sellers_not_onboarded_metric: $ref: '#/components/schemas/PlatformInsightResourceTopSellersNotOnboardedMetric' ad_accounts_not_advertising_metric: $ref: '#/components/schemas/PlatformInsightResourceAdAccountsNotAdvertisingMetric' ad_accounts_under_advertising_item_metric: $ref: '#/components/schemas/PlatformInsightResourceAdAccountsUnderAdvertisingItemMetric' campaigns_low_budget_metric: $ref: '#/components/schemas/PlatformInsightResourceCampaignsLowBudgetMetric' campaigns_low_bid_metric: $ref: '#/components/schemas/PlatformInsightResourceCampaignsLowBidMetric' campaigns_high_target_roas_metric: $ref: '#/components/schemas/PlatformInsightResourceCampaignsHighTargetRoasMetric' description: PlatformInsightResource represents a resource that contains platform insights. required: - metric_type additionalProperties: true v1PlatformInsightResourceMetricType: type: string enum: - METRIC_TYPE_UNKNOWN - METRIC_TYPE_AD_ACCOUNTS_WALLET_RUNNING_LOW - METRIC_TYPE_AD_ACCOUNTS_NEARING_SPENDING_LIMIT - METRIC_TYPE_CAMPAIGNS_EXPIRING_SOON - METRIC_TYPE_TOP_SELLERS_NOT_ONBOARDED - METRIC_TYPE_AD_ACCOUNTS_NOT_ADVERTISING - METRIC_TYPE_AD_ACCOUNTS_UNDER_ADVERTISING_ITEM - METRIC_TYPE_CAMPAIGNS_LOW_BUDGET - METRIC_TYPE_CAMPAIGNS_LOW_BID - METRIC_TYPE_CAMPAIGNS_HIGH_TARGET_ROAS default: METRIC_TYPE_UNKNOWN v1PlatformOwnerConfig: type: object properties: id: type: string description: The id of the Platform. readOnly: true title: type: string description: A descriptive name of the Platform. userspace_id: type: string description: The Userspace ID associated with the Platform. readOnly: true logo_url: type: string description: The URL of the Platform's logo image. embedding_api_key: type: string description: The embedding API key used for validating embedding APIs. api_keys: type: array items: $ref: '#/components/schemas/PlatformOwnerConfigAPIKey' description: Collection of API keys. We limit the max number to 20 during validation. readOnly: true timezone: type: string description: Timezone of the Platform. Immutable. currency: $ref: '#/components/schemas/rmpcommonCurrency' onsite_auction_config: $ref: '#/components/schemas/platformOnsiteAuctionConfig' use_recommendation_only: type: boolean description: 'Flag for only using recommendation API. Default: false' attribution_window: $ref: '#/components/schemas/v1PlatformOwnerConfigAttributionWindow' max_campaign_life_in_days: type: integer format: int64 description: Maximum life for each Campaign in the Platform in days. inventory_types: type: array items: $ref: '#/components/schemas/PlatformOwnerConfigInventoryType' description: Inventory types supported in the Platform. catalog_item_properties: type: array items: $ref: '#/components/schemas/platformCatalogItemProperty' description: Item properties displayed in the UI. is_for_test: type: boolean description: 'Indicates whether this Platform is for test purposes. Default: false' readOnly: true client_domains: type: array items: type: string description: Domain names of frontend websites for the Platform. readOnly: true allowed_creative_url_domains: type: array items: type: string description: Domains allowed for URL-based creative uploads. readOnly: true budget_range: $ref: '#/components/schemas/rmpcommonMicroRange' default_ad_account_state: $ref: '#/components/schemas/v1AdAccountStateInfoAdAccountState' created_at: type: string format: date-time description: Created timestamp. API user should not touch this field; it is set internally. readOnly: true updated_at: type: string format: date-time description: Updated timestamp. Set internally during creation, but required during update. onsite_creative_auction_config: $ref: '#/components/schemas/platformOnsiteCreativeAuctionConfig' locale: type: string description: Locale of the Platform. Immutable. zone: $ref: '#/components/schemas/rmpcommonZone' report_config: $ref: '#/components/schemas/platformReportConfig' spending_limit_config: $ref: '#/components/schemas/platformSpendingLimitConfig' landing_url_config: $ref: '#/components/schemas/platformLandingUrlConfig' managed_config: $ref: '#/components/schemas/platformManagedConfig' smart_selection_config: $ref: '#/components/schemas/platformSmartSelectionConfig' guidance_config: $ref: '#/components/schemas/platformGuidanceConfig' sponsored_brand_config: $ref: '#/components/schemas/commonplatformSponsoredBrandConfig' sponsored_display_config: $ref: '#/components/schemas/platformSponsoredDisplayConfig' predefined_audience_config: $ref: '#/components/schemas/platformPredefinedAudienceConfig' catalog_item_external_id_attributes: type: array items: $ref: '#/components/schemas/platformCatalogItemExternalIdAttribute' description: External ID attributes of the catalog item. catalog_config: $ref: '#/components/schemas/platformCatalogConfig' description: Definition of a PlatformOwnerConfig. required: - id - title - userspace_id - timezone - currency - onsite_auction_config - inventory_types - budget_range - default_ad_account_state additionalProperties: true v1PlatformOwnerConfigAttributionWindow: type: string enum: - UNKNOWN_WINDOW - THIRTY_MINUTES_WINDOW - SIXTY_MINUTES_WINDOW - ONE_DAY_WINDOW - SEVEN_DAYS_WINDOW - FOURTEEN_DAYS_WINDOW - TWENTY_ONE_DAYS_WINDOW - TWENTY_EIGHT_DAYS_WINDOW - THIRTY_DAYS_WINDOW default: UNKNOWN_WINDOW v1PlatformSummaryGroupByColumn: type: string enum: - UNKNOWN_GROUP_BY - DATE - AD_ACCOUNT - CURRENCY - CAMPAIGN - ITEM - INVENTORY_ID - CREATIVE - AD_MANAGER_ACCOUNT - ASSET default: UNKNOWN_GROUP_BY description: ' - UNKNOWN_GROUP_BY: This value is not part of the API specification.' v1PlatformSummaryOrderByColumn: type: string enum: - UNKNOWN_ORDER_BY - TIME_DATE - TIME_DATE_DESC - TIMEZONE - TIMEZONE_DESC - CURRENCY_DIM - CURRENCY_DIM_DESC - AD_MANAGER_ACCOUNT_TITLE - AD_MANAGER_ACCOUNT_TITLE_DESC - AD_ACCOUNT_ID - AD_ACCOUNT_ID_DESC - AD_ACCOUNT_TITLE - AD_ACCOUNT_TITLE_DESC - CATALOG_ITEM_TITLE - CATALOG_ITEM_TITLE_DESC - CAMPAIGN_ID - CAMPAIGN_ID_DESC - CAMPAIGN_TITLE - CAMPAIGN_TITLE_DESC - CATALOG_ITEM_ID - CATALOG_ITEM_ID_DESC - INVENTORY_DIM - INVENTORY_DIM_DESC - CREATIVE_ID - CREATIVE_ID_DESC - CREATIVE_TITLE - CREATIVE_TITLE_DESC - IMP_COUNT - IMP_COUNT_DESC - CLICK_COUNT - CLICK_COUNT_DESC - MONEY_SPENT - MONEY_SPENT_DESC - PURCHASE_COUNT - PURCHASE_COUNT_DESC - REVENUE - REVENUE_DESC - ROAS - ROAS_DESC - CPC - CPC_DESC - CR - CR_DESC - CTR - CTR_DESC - IMP_TO_PURCHASE - IMP_TO_PURCHASE_DESC - NUM_AD_ACCOUNTS - NUM_AD_ACCOUNTS_DESC - ITEMS_PER_AD_ACCOUNT - ITEMS_PER_AD_ACCOUNT_DESC - ACOS - ACOS_DESC - CPM - CPM_DESC default: UNKNOWN_ORDER_BY title: "- UNKNOWN_ORDER_BY: This value is not part of the API specification.\n - IMP_COUNT: Metrics" v1PlatformSummaryRow: type: object properties: date: type: string description: Date in 'YYYY-MM-DD'. timezone: type: string description: Timezone of date in the data. currency: type: string description: Currency. ad_account_id: type: string description: Ad account id. ad_account_title: type: string description: Ad account title. campaign_id: type: string description: Campaign id. campaign_title: type: string description: Campaign title. catalog_item_id: type: string description: Catalog item id. catalog_item_title: type: string description: Catalog item title. creative_id: type: string description: Creative id. creative_title: type: string description: Creative title. asset_id: type: string description: Asset id. inventory_id: type: string description: Inventory id. imp_count: type: string format: int64 description: Impression count. imp_item_count: type: string format: int64 description: Per item impression count. Only populated for item-level group by results with Sponsored Brand campaign. click_count: type: string format: int64 description: Click count. money_spent: type: string format: int64 description: Money spent. It is in a micro unit. purchase_count: type: string format: int64 description: Purchase count. purchase_breakdown: $ref: '#/components/schemas/commonHaloMetricInt' revenue: type: string format: int64 description: Money earned. It is in a micro unit. revenue_breakdown: $ref: '#/components/schemas/commonHaloMetricInt' roas: type: number format: double description: ROAS in percent. roas_breakdown: $ref: '#/components/schemas/commonHaloMetricDouble' cr: type: number format: double description: CR. Click to Purchase rate. ctr: type: number format: double description: CTR. Click divided by Impressions. ctr_item: type: number format: double description: CTR per item-level impression. Click divided by imp_item_count, in percent. Only populated for item-level group by results with Sponsored Brand campaign. imp_to_purchase: type: number format: double description: CTR multiplied by CR (CTR x CR). imp_item_to_purchase: type: number format: double description: Purchase rate per item-level impression. Purchase divided by imp_item_count, in percent. Only populated for item-level group by results with Sponsored Brand campaign. num_ad_accounts: type: string format: int64 description: Number of active ad accounts during selected time period (platform summary specific). items_per_ad_account: type: number format: double description: Items per ad account (platform summary specific). cpc: type: number format: double description: CPC (Cost Per Click) in a micro unit. acos: type: number format: double description: Advertising cost of sales in percent. Ad Spending / Revenue cpm: type: number format: double description: CPM (Cost Per 1,000 Impressions) in a micro unit. cpm_item: type: number format: double description: CPM per item-level impression in a micro unit. Money spent divided by imp_item_count, multiplied by 1,000. Only populated for item-level group by results with Sponsored Brand campaign. description: PlatformSummaryRow represents a row of platform-level summarized reporting. additionalProperties: true v1PlatformUserConfig: type: object properties: id: type: string description: The id of the Platform. title: type: string description: A descriptive name of the Platform. userspace_id: type: string description: The Userspace ID associated with the Platform. logo_url: type: string description: The URL of the Platform's logo image. timezone: type: string description: Timezone of the Platform. Immutable. currency: $ref: '#/components/schemas/rmpcommonCurrency' onsite_auction_config: $ref: '#/components/schemas/platformOnsiteAuctionConfig' locale: type: string description: Locale of the Platform. Immutable. zone: $ref: '#/components/schemas/rmpcommonZone' onsite_creative_auction_config: $ref: '#/components/schemas/platformOnsiteCreativeAuctionConfig' max_campaign_life_in_days: type: integer format: int64 description: Maximum life for each Campaign in the Platform in days. catalog_item_properties: type: array items: $ref: '#/components/schemas/platformCatalogItemProperty' description: Item properties displayed in the UI. allowed_creative_url_domains: type: array items: type: string description: Domains allowed for URL-based creative uploads. readOnly: true budget_range: $ref: '#/components/schemas/rmpcommonMicroRange' created_at: type: string format: date-time description: Created timestamp. API user should not touch this field; it is set internally. readOnly: true updated_at: type: string format: date-time description: Updated timestamp. Set internally during creation, but required during update. audience_types: type: array items: $ref: '#/components/schemas/commonoffsiteAudienceType' description: Supported audience types of the Platform. report_config: $ref: '#/components/schemas/platformReportConfig' spending_limit_config: $ref: '#/components/schemas/platformSpendingLimitConfig' landing_url_config: $ref: '#/components/schemas/platformLandingUrlConfig' smart_selection_config: $ref: '#/components/schemas/platformSmartSelectionConfig' guidance_config: $ref: '#/components/schemas/platformGuidanceConfig' sponsored_brand_config: $ref: '#/components/schemas/commonplatformSponsoredBrandConfig' sponsored_display_config: $ref: '#/components/schemas/platformSponsoredDisplayConfig' predefined_audience_config: $ref: '#/components/schemas/platformPredefinedAudienceConfig' billing_config: $ref: '#/components/schemas/platformBillingConfig' catalog_item_external_id_attributes: type: array items: $ref: '#/components/schemas/platformCatalogItemExternalIdAttribute' description: External ID attributes of the catalog item. item_based_guidance_config: $ref: '#/components/schemas/platformItemBasedGuidanceConfig' campaign_quota_config: $ref: '#/components/schemas/platformCampaignQuotaConfig' description: Definition of a PlatformUserConfig. required: - id - title - userspace_id - timezone - currency - onsite_auction_config - max_campaign_life_in_days - budget_range - audience_types additionalProperties: true v1PredefinedAudienceChangeLog: type: object properties: method: $ref: '#/components/schemas/EntityChangeLogEntityChangeMethod' entity_id: type: string description: The id of the entity. field_type: $ref: '#/components/schemas/EntityChangeLogFieldType' field_name: type: string description: The name of the field. field_before: type: string description: Field value before the change. field_after: type: string description: Field value after the change. metadata: $ref: '#/components/schemas/v1PredefinedAudienceChangeLogMetadata' updated_at: type: string format: date-time description: Updated timestamp of the entity. changed_by: $ref: '#/components/schemas/v1ChangeLogUser' description: Definition of a PredefinedAudienceChangeLog. required: - method - entity_id - field_type - field_name - field_before - field_after - metadata - updated_at - changed_by additionalProperties: true v1PredefinedAudienceChangeLogMetadata: type: object properties: audience_id: type: string description: The id of the audience. audience_label: type: string description: The label of the audience. Optional. additionalProperties: true v1RawUser: type: object properties: configuration: type: object additionalProperties: type: string description: The configuration of the RawUser. created_at: type: string description: The time when the RawUser information is created. updated_at: type: string description: The time when the RawUser information is updated. id: type: string description: The id of the RawUser. email: type: string description: The email address of the RawUser. name: type: string description: The name of the RawUser. userspace_id: type: string description: The id of the userspace. roles: type: array items: $ref: '#/components/schemas/v1RoleReference' description: The list of roles assigned to the RawUser. role_grants: type: array items: $ref: '#/components/schemas/v1RoleGrant' description: The detailed list of roles granted to the RawUser. description: Definition of a RawUser. additionalProperties: true v1RegistrationStatus: type: string enum: - UNKNOWN_STATE - NOT_REGISTERED - REGISTERED default: UNKNOWN_STATE v1ReportSummaryFilterColumn: type: string enum: - UNKNOWN_FILTER_FIELD - CAMPAIGN_FILTER default: UNKNOWN_FILTER_FIELD v1ReportSummaryFilterOperator: type: string enum: - UNKNOWN_FILTER_OPERATOR - EQ - IN default: UNKNOWN_FILTER_OPERATOR v1RoleGrant: type: object properties: resource_id: type: string description: The id of the resource to which the roles are granted resource_instance_id: type: string description: The actual instance id of the resource to which the roles are granted. roles: type: array items: $ref: '#/components/schemas/v1RoleReference' description: The list of roles assigned to the user. additionalProperties: true v1RoleName: type: string enum: - UNKNOWN_ROLE_NAME - PLATFORM_OWNER - PLATFORM_USER - AD_ACCOUNT_OWNER - AD_ACCOUNT_USER - AD_ACCOUNT_AGENCY - CREATIVE_REVIEWER default: UNKNOWN_ROLE_NAME v1RoleReference: type: object properties: id: type: string description: The id of the role platform_id: type: string description: The platform ID where the role is defined. additionalProperties: true v1Seller: type: object properties: id: type: string description: The id of the Seller. title: type: string description: A descriptive name of the Seller. is_registered: type: boolean description: Registration state of the Seller. description: Definition of a Seller. required: - id - title - is_registered additionalProperties: true v1SpendCap: type: object properties: id: type: string description: "The id of the SpendCap.\n must be left unset for the SpendCap creation request.\n must be set for\ \ the update request." title: type: string description: A descriptive name of the SpendCap. ad_account_id: type: string description: "The id of the AdAccount that owns this SpendCap.\n it is mcm platform specific ad account id.\n value\ \ and format can vary according to each mcm platform." currency: $ref: '#/components/schemas/rmpcommonCurrency' schedule: $ref: '#/components/schemas/rmpcommonTimeInterval' budget: $ref: '#/components/schemas/rmpcommonMoneyMicro' applied_ad_spending: $ref: '#/components/schemas/rmpcommonMoneyMicro' status: $ref: '#/components/schemas/v1SpendCapSpendCapStatus' metadata: $ref: '#/components/schemas/v1SpendCapMetadata' created_at: type: string format: date-time description: "Created timestamp.\n API user should not touch this field; it is set internally." updated_at: type: string format: date-time description: Updated timestamp. It is set internally. description: Definition of Spend Cap. additionalProperties: true v1SpendCapCampaignAssignment: type: object properties: assignment_id: type: string description: Stable identifier of the assignment record. spend_cap_id: type: string description: Spend Cap id. campaign_id: type: string description: Campaign id. effective_from: type: string format: date-time description: Timestamp from which this assignment record becomes effective. Omitted when the platform uses legacy campaign-level assignment. effective_to: type: string format: date-time description: Timestamp until which this assignment record is effective. Omitted for open-ended assignments. description: Campaign assignment record of a SpendCap. required: - spend_cap_id - campaign_id additionalProperties: true v1SpendCapMetadata: type: object properties: reference: type: string description: To store reference information about the SpendCap. additionalProperties: true v1SpendCapOverview: type: object properties: spend_cap_id: type: string spend_cap_title: type: string purpose: $ref: '#/components/schemas/SpendCapPurpose' period: $ref: '#/components/schemas/v1SpendCapPeriod' status: $ref: '#/components/schemas/v1SpendCapSpendCapStatus' campaign_assignment_scope: $ref: '#/components/schemas/SpendCapCampaignAssignmentScope' currency: type: string description: Currency of the SpendCap. remaining_amount: type: string format: int64 description: Remaining amount of the SpendCap. total_amount: type: string format: int64 description: Budget of the SpendCap. usage: type: number format: double description: Usage of the SpendCap budget. Spent Amount / Total Amount in percentage. schedule: $ref: '#/components/schemas/rmpcommonTimeInterval' num_assigned_campaigns: type: integer format: int64 additionalProperties: true v1SpendCapPeriod: type: string enum: - UNKNOWN_PERIOD - DAILY - WEEKLY - TOTAL default: UNKNOWN_PERIOD description: 'Period describes the cadence on which the SpendCap budget resets. DAILY / WEEKLY / MONTHLY produce a recurring ledger; TOTAL means the cap covers the entire schedule as a single window. This enum is intentionally separate from common.Budget.Period (used by campaigns), which does NOT have a MONTHLY value — campaigns may not use a monthly cadence. Numeric values are arranged so the recurring kinds are grouped (DAILY=1, WEEKLY=2, MONTHLY=3), with TOTAL=4 as the non-recurring case. Public mgmt access is REST/JSON-only and proto-JSON encodes enums by name, so the legacy binary numbering of common.Budget.Period is not relevant here.' v1SpendCapSpendCapStatus: type: string enum: - UNKNOWN_SPEND_CAP_STATUS - SCHEDULED - INACTIVE - ACTIVE - ENDED - DEPLETED - ERROR default: UNKNOWN_SPEND_CAP_STATUS description: " - SCHEDULED: The SpendCap is not in an Active state due to an unexpected error case\n Similar to the\ \ Scheduled state of a campaign, the SpendCap is in a “reserved” state because its period has not yet started.\n -\ \ INACTIVE: The status when the user manually changes the SpendCap from Active to Inactive.\n - ACTIVE: The SpendCap\ \ is in an Active state. As long as the amount is not depleted, the mapped campaigns can remain Active and serve ads\ \ without issues\n - ENDED: One of the cases where the SpendCap is no longer Active because its defined period has\ \ ended.\n - DEPLETED: The SpendCap has reached its allocated amount (0 remaining). As a result, the mapped campaigns\ \ can no longer remain active and ad serving stops, even though the period itself has not yet ended.\n - ERROR: Error\ \ state. The campaign state does not belong to any states above." v1SpendCapTransactionLog: type: object properties: type: $ref: '#/components/schemas/v1SpendCapTransactionLogType' transaction_status: $ref: '#/components/schemas/v1SpendCapTransactionLogTransactionStatus' budget_change: $ref: '#/components/schemas/rmpcommonMoneyMicro' posted_at: type: string format: date-time description: The time when the transaction was posted. transaction_date: type: string description: The date of the transaction. e.g. 2006-01-02 description: Definition of a SpendCap Transaction Log. required: - type - transaction_status - transaction_date additionalProperties: true v1SpendCapTransactionLogTransactionStatus: type: string enum: - UNKNOWN_TRANSACTION_STATUS - PENDING - POSTED default: UNKNOWN_TRANSACTION_STATUS v1SpendCapTransactionLogType: type: string enum: - UNKNOWN_TYPE - SPENT default: UNKNOWN_TYPE v1SpendingLimit: type: object properties: id: type: string description: The id of the Wallet. Must be left unset for the Wallet creation request. Must be set for the other requests. title: type: string description: A friendly name for the spending limit. ad_account_id: type: string description: The id of the AdAccount for this spending limit. spent_since_reset: $ref: '#/components/schemas/rmpcommonMoneyMicro' remaining_since_reset: $ref: '#/components/schemas/rmpcommonMoneyMicro' spending_limit_micro: $ref: '#/components/schemas/v1SpendingLimitMicro' reset_timestamps: $ref: '#/components/schemas/v1SpendingLimitResetTimestamps' created_at: type: string format: date-time description: Created timestamp. API user should not touch this field; it is set internally. readOnly: true updated_at: type: string format: date-time description: Updated timestamp. Set internally during creation, but required during update. description: Definition of a SpendingLimit. required: - id - ad_account_id - spent_since_reset - remaining_since_reset - spending_limit_micro - reset_timestamps - created_at - updated_at additionalProperties: true v1SpendingLimitCreditHistory: type: object properties: type: $ref: '#/components/schemas/v1SpendingLimitCreditHistoryType' transaction_status: $ref: '#/components/schemas/v1SpendingLimitCreditHistoryTransactionStatus' budget_change: $ref: '#/components/schemas/v1SpendingLimitCreditHistoryMoneyMicroByAccount' balance: $ref: '#/components/schemas/v1SpendingLimitCreditHistoryMoneyMicroByAccount' posted_at: type: string format: date-time description: Posted timestamp of the transaction. transaction_date: type: string description: Transaction date. e.g., 2006-01-02 metadata: $ref: '#/components/schemas/v1SpendingLimitCreditHistoryMetadata' changed_by: $ref: '#/components/schemas/v1SpendingLimitCreditHistoryChangedBy' required: - type - transaction_status - budget_change - balance - posted_at - transaction_date additionalProperties: true v1SpendingLimitCreditHistoryChangedBy: type: object properties: id: type: string name: type: string email: type: string role: $ref: '#/components/schemas/v1RoleName' additionalProperties: true v1SpendingLimitCreditHistoryMetadata: type: object properties: comment: type: string description: A comment for transaction. Optional. additionalProperties: true v1SpendingLimitCreditHistoryMoneyMicroByAccount: type: object properties: credits: $ref: '#/components/schemas/rmpcommonMoneyMicro' additionalProperties: true v1SpendingLimitCreditHistoryTransactionStatus: type: string enum: - UNKNOWN_TRANSACTION_STATUS - PENDING - POSTED default: UNKNOWN_TRANSACTION_STATUS v1SpendingLimitCreditHistoryType: type: string enum: - UNKNOWN_TYPE - FUNDED - REFUNDED - SPENT default: UNKNOWN_TYPE v1SpendingLimitMicro: type: object properties: last_spending_limit: $ref: '#/components/schemas/rmpcommonMoneyMicro' next_spending_limit: $ref: '#/components/schemas/rmpcommonMoneyMicro' description: Definition of a SpendingLimitMicro. required: - last_spending_limit - next_spending_limit additionalProperties: true v1SpendingLimitResetTimestamps: type: object properties: last_reset_at: type: string format: date-time next_reset_at: type: string format: date-time required: - last_reset_at - next_reset_at additionalProperties: true v1Targeting: type: object properties: placement_setting: $ref: '#/components/schemas/TargetingPlacementSetting' audience_setting: $ref: '#/components/schemas/TargetingAudienceSetting' custom_setting: $ref: '#/components/schemas/TargetingCustomSetting' description: Targeting describes the detailed targeting spec for the campaign. additionalProperties: true v1TargetingReportSummaryQueryFilter: type: object properties: filter_operator: $ref: '#/components/schemas/v1ReportSummaryFilterOperator' values: type: array items: type: string description: IDs to be filtered by. To be used with IN operator. IN operator is only supported for Campaign Filter column. The maximum number of values is 5. additionalProperties: true v1UpdateItemFailureInfo: type: object properties: item_id: type: string description: The id of the item. seller_id: type: string description: The id of the seller. message: type: string description: The error message of failure. description: Information of the item that failed to update. required: - item_id - message additionalProperties: true v1UpdateItemSuccessInfo: type: object properties: item_id: type: string description: The id of the item. seller_id: type: string description: The id of the seller. description: Information of the item that succeed to update. required: - item_id additionalProperties: true v1User: type: object properties: id: type: string description: The id of the User. Set internally during creation. readOnly: true email: type: string description: The email of the User, Immutable. name: type: string description: The name of the User. If this field is not set, a parsed email will be used. roles: type: array items: $ref: '#/components/schemas/managementv1Role' description: The roles that are granted to the User. status: $ref: '#/components/schemas/v1RegistrationStatus' created_at: type: string format: date-time description: Created timestamp. API user should not touch this field; it is set internally. readOnly: true updated_at: type: string format: date-time description: Updated timestamp. Set internally during creation, but required during update. description: Definition of a User. required: - id - email - status - created_at - updated_at additionalProperties: true v1UserAccessChangeLog: type: object properties: activity: $ref: '#/components/schemas/UserAccessChangeLogActivity' platform_id: type: string description: Indicates the identifier of the platform. ad_account_id: type: string description: Indicates the identifier of the ad account. ad_account_title: type: string description: Indicates the descriptive name of the ad account. ad_manager_account_id: type: string description: Indicates the identifier of the ad manager account. ad_manager_account_title: type: string description: Indicates the descriptive name of the ad manager account. user_id: type: string description: The id of the target user. user_email: type: string description: The email of the target user. user_name: type: string description: The descriptive name of the target user. user_role_before: $ref: '#/components/schemas/v1RoleName' user_role_after: $ref: '#/components/schemas/v1RoleName' reason: type: string description: The rejection reason of the target user. changed_by: $ref: '#/components/schemas/v1ChangeLogUser' updated_at: type: string format: date-time description: Updated timestamp of the entity. description: Definition of a UserAccessChangeLog. required: - activity - platform_id - ad_account_id - ad_account_title - ad_manager_account_id - ad_manager_account_title - user_id - user_email - user_name - user_role_before - user_role_after - reason - updated_at additionalProperties: true v1UserAccessChangeLogFilter: type: object properties: activity: $ref: '#/components/schemas/UserAccessChangeLogActivity' user_id: type: string description: Identifier of the user. description: Definition of a ChangeLogFilter. The fields in the message compose AND condition filter. additionalProperties: true v1UserJoinRequest: type: object properties: id: type: string description: The id of the UserJoinRequest. Generated automatically. ad_account_id: type: string description: The requester’s ad account id. ad_account_title: type: string description: The requester’s ad account title. user_email: type: string description: The requester’s user email. It will be used as an identifier. user_name: type: string description: The requester’s user name. If this field is not set, a parsed email will be used. role: $ref: '#/components/schemas/v1RoleName' created_at: type: string format: date-time description: Created timestamp. API user should not touch this field; it is set internally. readOnly: true updated_at: type: string format: date-time description: Updated timestamp. API user should not touch this field; it is set internally. readOnly: true description: Definition of a UserJoinRequest. required: - ad_account_id - user_email - created_at - updated_at additionalProperties: true v1UserRegistration: type: object properties: is_created: type: boolean description: The type of the resource. registration_info: $ref: '#/components/schemas/UserRegistrationRegistrationInfo' description: Definition of a User Registration specification. readOnly: true required: - is_created additionalProperties: true v1VideoAsset: type: object properties: id: type: string description: The id of the video asset. Must be left unset for the video asset creation request. Must be set for the other requests. readOnly: true ad_account_id: type: string description: The id of the ad account that owns this video asset. It is platform-specific ad_account_id. Value and format can vary according to each Platform. readOnly: true video_source: $ref: '#/components/schemas/v1VideoSource' created_at: type: string format: date-time description: Created timestamp. API user should not touch this field; it is set internally in creation process. readOnly: true description: VideoAsset that could be used for the campaign's asset. additionalProperties: true v1VideoSource: type: object properties: url: type: string description: The URL of the video. readOnly: true file_name: type: string description: The file name of the video. readOnly: true width: type: integer format: int64 description: The width of the video. readOnly: true height: type: integer format: int64 description: The height of the video. readOnly: true size_bytes: type: integer format: int64 description: The file size in bytes of the video. readOnly: true duration_sec: type: integer format: int64 description: The duration of the video in seconds. readOnly: true status: $ref: '#/components/schemas/v1VideoSourceStatus' description: Detailed information of a video. additionalProperties: true v1VideoSourceStatus: type: string enum: - UNKNOWN_STATUS - PENDING - READY default: UNKNOWN_STATUS description: " - PENDING: The video asset isn't ready to use yet.\n - READY: The video asset is ready to use." v1Wallet: type: object properties: id: type: string description: The id of the Wallet. Must be left unset for the Wallet creation request. Must be set for the other requests. title: type: string description: A friendly name for the Wallet. ad_account_id: type: string description: The id of the AdAccount that owns this Wallet. It is platform-specific ad_account_id. Value and format can vary according to each Platform. type: $ref: '#/components/schemas/commonWalletType' accounts: type: array items: $ref: '#/components/schemas/v1Account' description: List of Accounts that belong to the wallet. created_at: type: string format: date-time description: Created timestamp. API user should not touch this field; it is set internally. readOnly: true updated_at: type: string format: date-time description: Updated timestamp. Set internally during creation, but required during update. description: Definition of a Wallet. required: - id - ad_account_id - type - accounts - created_at - updated_at additionalProperties: true v1WalletAccountHistoryLog: type: object properties: type: $ref: '#/components/schemas/v1WalletAccountHistoryLogType' budget_change: $ref: '#/components/schemas/v1WalletAccountHistoryLogMoneyMicroByAccount' balance: $ref: '#/components/schemas/v1WalletAccountHistoryLogMoneyMicroByAccount' updated_at: type: string format: date-time description: Updated timestamp of wallet. metadata: $ref: '#/components/schemas/v1WalletAccountHistoryLogMetadata' changed_by: $ref: '#/components/schemas/v1WalletAccountHistoryLogChangedBy' description: Definition of a WalletAccountHistoryLog. required: - type - budget_change - balance - updated_at additionalProperties: true v1WalletAccountHistoryLogChangedBy: type: object properties: id: type: string name: type: string email: type: string role: $ref: '#/components/schemas/v1RoleName' additionalProperties: true v1WalletAccountHistoryLogMetadata: type: object properties: comment: type: string description: A comment for transaction. Optional. additionalProperties: true v1WalletAccountHistoryLogMoneyMicroByAccount: type: object properties: credits: $ref: '#/components/schemas/rmpcommonMoneyMicro' prepaid: $ref: '#/components/schemas/rmpcommonMoneyMicro' total: $ref: '#/components/schemas/rmpcommonMoneyMicro' additionalProperties: true v1WalletAccountHistoryLogType: type: string enum: - UNKNOWN_TYPE - FUNDED - REFUNDED - SPENT default: UNKNOWN_TYPE v1WalletTransactionHistory: type: object properties: type: $ref: '#/components/schemas/v1WalletTransactionHistoryType' transaction_status: $ref: '#/components/schemas/v1WalletTransactionHistoryTransactionStatus' budget_change: $ref: '#/components/schemas/v1WalletTransactionHistoryMoneyMicroByAccount' balance: $ref: '#/components/schemas/v1WalletTransactionHistoryMoneyMicroByAccount' posted_at: type: string format: date-time description: The time when the transaction was posted. transaction_date: type: string description: The date of the transaction. e.g. 2006-01-02 metadata: $ref: '#/components/schemas/v1WalletTransactionHistoryMetadata' changed_by: $ref: '#/components/schemas/v1WalletTransactionHistoryChangedBy' description: Definition of a Wallet Transaction History. required: - type - transaction_status - budget_change - balance - transaction_date additionalProperties: true v1WalletTransactionHistoryChangedBy: type: object properties: id: type: string description: The id of the user who changed the transaction. name: type: string description: The name of the user who changed the transaction. email: type: string description: The email of the user who changed the transaction. role: $ref: '#/components/schemas/v1RoleName' additionalProperties: true v1WalletTransactionHistoryMetadata: type: object properties: comment: type: string description: Comment for the transaction. additionalProperties: true v1WalletTransactionHistoryMoneyMicroByAccount: type: object properties: credits: $ref: '#/components/schemas/rmpcommonMoneyMicro' prepaid: $ref: '#/components/schemas/rmpcommonMoneyMicro' total: $ref: '#/components/schemas/rmpcommonMoneyMicro' additionalProperties: true v1WalletTransactionHistoryTransactionStatus: type: string enum: - UNKNOWN_TRANSACTION_STATUS - PENDING - POSTED default: UNKNOWN_TRANSACTION_STATUS v1WalletTransactionHistoryType: type: string enum: - UNKNOWN_TYPE - FUNDED - REFUNDED - SPENT default: UNKNOWN_TYPE v1WebhookDelivery: type: object properties: id: type: string description: The id of the delivery. is_test: type: boolean description: Whether this delivery was produced by a test send. status: $ref: '#/components/schemas/notificationv1Status' event: type: string description: The WebhookEvent wire token (e.g. "campaign.budget.high_upsell"). created_at: type: string format: date-time description: Creation timestamp of the delivery. request_body: type: string description: The raw request body that was (or would be) POSTed to the endpoint. endpoint_id: type: string description: The id of the endpoint this delivery was sent to. Useful when querying deliveries across endpoints. description: Definition of a webhook delivery. required: - id - status - event additionalProperties: true v1WebhookEndpoint: type: object properties: id: type: string description: The id of the webhook endpoint. Server-assigned on creation; leave unset on CreateWebhookEndpoint. url: type: string description: The HTTPS URL that deliveries are POSTed to. description: type: string description: Human-readable description of the endpoint. Optional. subscribed_events: type: array items: $ref: '#/components/schemas/v1WebhookEvent' description: The webhook events this endpoint is subscribed to. enabled: type: boolean description: Whether the endpoint is enabled. Disabled endpoints do not receive deliveries. retry_policy: $ref: '#/components/schemas/v1WebhookRetryPolicy' created_at: type: string format: date-time description: Creation timestamp of the endpoint. updated_at: type: string format: date-time description: Last-updated timestamp of the endpoint. Doubles as the optimistic-lock token on update. name: type: string description: Human-readable display name of the endpoint. Optional, mutable. description: Definition of a webhook endpoint. required: - url - subscribed_events - enabled additionalProperties: true v1WebhookEvent: type: string enum: - WEBHOOK_EVENT_UNSPECIFIED - WEBHOOK_EVENT_CAMPAIGN_BUDGET_HIGH_UPSELL - WEBHOOK_EVENT_ADVERTISER_RE_ENGAGE_CHURNED default: WEBHOOK_EVENT_UNSPECIFIED description: "WebhookEvent enumerates the public-facing webhook event types a platform can\nsubscribe to. Each value\ \ maps 1:1 to a rmp.notification.v1.NotificationEvent\nWEBHOOK_EVENT_* value. The wire token (e.g. \"campaign.budget.high_upsell\"\ )\nis the value emitted in the delivered payload's `event` field.\n\n - WEBHOOK_EVENT_CAMPAIGN_BUDGET_HIGH_UPSELL:\ \ wire: \"campaign.budget.high_upsell\"\n - WEBHOOK_EVENT_ADVERTISER_RE_ENGAGE_CHURNED: wire: \"advertiser.re_engage.churned\"" v1WebhookRetryPolicy: type: object properties: max_attempts: type: integer format: int32 description: 'Maximum number of delivery attempts before the delivery is marked failed. Default: 3, Max: 5.' retry_interval_seconds: type: integer format: int32 description: 'Interval between retry attempts, in seconds. Default: 10.' description: Retry policy for a webhook endpoint. additionalProperties: true v1WebhookSigningKey: type: object properties: id: type: string description: The id of the signing key. endpoint_id: type: string description: The id of the endpoint this key belongs to. secret_prefix: type: string description: Non-sensitive prefix of the signing secret, for identification in lists. status: $ref: '#/components/schemas/v1WebhookSigningKeyStatus' created_at: type: string format: date-time description: Creation timestamp of the signing key. revoked_at: type: string format: date-time description: Revocation timestamp of the signing key. Null while ACTIVE. description: Definition of a webhook signing key. required: - id - endpoint_id - secret_prefix - status additionalProperties: true v1WebhookSigningKeyStatus: type: string enum: - STATUS_UNSPECIFIED - ACTIVE - REVOKED default: STATUS_UNSPECIFIED description: Status indicates whether a signing key is currently usable.