### HTTP Request Example (Curl)

Source: https://open.oceanengine.com/docs/1696710526192652

This example demonstrates how to make a GET request to the advertiser fund endpoint using curl. It includes the necessary Host, Content-Type, and Access-Token headers, along with the request body.

```curl
GET /open_api/2/advertiser/fund/get/ HTTP/1.1
Host: ad.oceanengine.com
Content-Type: application/json
Access-Token: xxx
{
    "advertiser_id": 0
}
```

--------------------------------

### Response Example

Source: https://open.oceanengine.com/docs/1714057019136013

An example of a successful API response.

```APIDOC
## Response Example

### Success Response (200)
```json
{
    "message": "OK",
    "code": 0,
    "data": {}
}
```
```

--------------------------------

### HTTP Response Example

Source: https://open.oceanengine.com/docs/1848384510986631

This is an example of a successful HTTP response, indicating a status code of 200 OK.

```http
HTTPS/1.1 200 OK
```

--------------------------------

### SDK Usage Introduction

Source: https://open.oceanengine.com/docs/1860068027672588

Guides on how to use the provided SDKs for Java and Go.

```APIDOC
## SDK Usage Introduction

### Description
This section provides instructions and guides for integrating and utilizing the Software Development Kits (SDKs) offered for Java and Go to interact with the platform's services.

### Java SDK Usage Guide
- Detailed instructions on how to set up and use the Java SDK.

### Go SDK Usage Guide
- Comprehensive guide for integrating and utilizing the Go SDK.

```

--------------------------------

### Go SDK Example for Creating an Order

Source: https://open.oceanengine.com/tools/visual_debug.html?docId=1794677902211227

Example of how to use the Go SDK to create an order. This snippet demonstrates the structure for making the API call in Go.

```go
package main

import (
	"fmt"
	"github.com/oceanengine/sdk/douplus"
)

func main() {
	// Initialize the API client
	client := douplus.NewClient("YOUR_ACCESS_TOKEN")

	// Define order parameters
	params := douplus.OrderCreateParams{
		AdvertiserID: 1234567890,
		OrderInfo: douplus.OrderInfo{
			ProjectID: "your_project_id",
			OrderType: "BUDGET",
			Budget:    1000.00,
			Starttime: "2023-10-26 00:00:00",
			Endtime:   "2023-10-27 00:00:00",
		},
		PromotionInfo: douplus.PromotionInfo{
			PromotionName: "My Promotion",
		},
	}

	// Create the order
	response, err := client.OrderCreate(params)
	if err != nil {
		fmt.Println("Error creating order:", err)
		return
	}

	// Process the response
	fmt.Println(response)
}
```

--------------------------------

### Get Advertiser Fund Balance (Python)

Source: https://open.oceanengine.com/docs/1696710526192652

Use this Python snippet to fetch the fund balance for a specific advertiser ID. Ensure you have the 'requests' library installed and a valid Access-Token.

```python
def advertiser_fund_get():
    import requests
    open_api_url_prefix = "https://ad.oceanengine.com/open_api/"
    uri = "2/advertiser/fund/get/"
    url = open_api_url_prefix + uri
    params = {
        "advertiser_id": 0
    }
    headers = {"Access-Token": "xxx"}
    rsp = requests.get(url, json=params, headers=headers)
    rsp_data = rsp.json()
    return rsp_data
```

--------------------------------

### Python: Query Advertiser Fund

Source: https://open.oceanengine.com/labels/7/docs/1696710526192652

Use this Python snippet to make a GET request to the advertiser fund endpoint. Ensure you have the 'requests' library installed. Replace 'xxx' with your actual Access-Token and '0' with the advertiser ID.

```python
import requests

open_api_url_prefix = "https://ad.oceanengine.com/open_api/"
uri = "2/advertiser/fund/get/"
url = open_api_url_prefix + uri

params = {
    "advertiser_id": 0
}

headers = {"Access-Token": "xxx"}

rsp = requests.get(url, json=params, headers=headers)
rsp_data = rsp.json()

return rsp_data
```

--------------------------------

### Python SDK Example for Creating an Order

Source: https://open.oceanengine.com/tools/visual_debug.html?docId=1794677902211227

Example of how to use the Python SDK to create an order. This snippet demonstrates setting up the client and making the order creation request.

```python
from openoceanengine.api.douplus import DouplusApi

# Initialize the API client
client = DouplusApi(access_token='YOUR_ACCESS_TOKEN')

# Define order parameters
order_params = {
    "advertiser_id": 1234567890,
    "order_info": {
        "project_id": "your_project_id",
        "order_type": "BUDGET",
        "budget": 1000.00,
        "start_time": "2023-10-26 00:00:00",
        "end_time": "2023-10-27 00:00:00"
    },
    "promotion_info": {
        "promotion_name": "My Promotion",
        "promotion_type": "" 
    }
}

# Create the order
response = client.order_create(**order_params)

# Process the response
print(response)
```

--------------------------------

### Java SDK Example for Creating an Order

Source: https://open.oceanengine.com/tools/visual_debug.html?docId=1794677902211227

Example of how to use the Java SDK to create an order. This snippet shows the necessary imports and method calls for order creation.

```java
import com.oceanengine.api.douplus.DouplusApi;
import com.oceanengine.api.douplus.model.order.OrderCreateParams;
import com.oceanengine.api.douplus.model.order.OrderInfo;
import com.oceanengine.api.douplus.model.order.PromotionInfo;

public class CreateOrderExample {
    public static void main(String[] args) {
        // Initialize the API client
        DouplusApi client = new DouplusApi("YOUR_ACCESS_TOKEN");

        // Define order parameters
        OrderCreateParams params = new OrderCreateParams();
        params.setAdvertiserId(1234567890L);

        OrderInfo orderInfo = new OrderInfo();
        orderInfo.setProjectId("your_project_id");
        orderInfo.setOrderType("BUDGET");
        orderInfo.setBudget(1000.00);
        orderInfo.setStartTime("2023-10-26 00:00:00");
        orderInfo.setEndTime("2023-10-27 00:00:00");
        params.setOrderInfo(orderInfo);

        PromotionInfo promotionInfo = new PromotionInfo();
        promotionInfo.setPromotionName("My Promotion");
        params.setPromotionInfo(promotionInfo);

        // Create the order
        Object response = client.orderCreate(params);

        // Process the response
        System.out.println(response);
    }
}
```

--------------------------------

### Query Financial Transaction Details - Python Example

Source: https://open.oceanengine.com/docs/1780627317170250

Use this Python code to retrieve financial transaction details for advertiser accounts. Ensure you have a valid Access-Token and provide the advertiser ID, start date, and end date.

```python
import requests

url = "https://api.oceanengine.com/open_api/2/advertiser/fund/transaction/get/"
headers = {
    "Access-Token": "YOUR_ACCESS_TOKEN",
}
params = {
    "advertiser_id": "1234567890",
    "start_date": "2023-01-01",
    "end_date": "2023-12-31",
    "transaction_type": "RECHARGE",
    "page": 1,
    "page_size": 10,
}

response = requests.get(url, headers=headers, params=params)

if response.status_code == 200:
    print(response.json())
else:
    print(f"Error: {response.status_code}")
    print(response.text)
```

--------------------------------

### PHP SDK Example for Creating an Order

Source: https://open.oceanengine.com/tools/visual_debug.html?docId=1794677902211227

Example of how to use the PHP SDK to create an order. This snippet illustrates the structure for making the API call.

```php
<?php

require_once __DIR__ . '/vendor/autoload.php';

use OceanengineSdk\Api\DouplusApi;

// Initialize the API client
$client = new DouplusApi('YOUR_ACCESS_TOKEN');

// Define order parameters
$params = [
    'advertiser_id' => 1234567890,
    'order_info' => [
        'project_id' => 'your_project_id',
        'order_type' => 'BUDGET',
        'budget' => 1000.00,
        'start_time' => '2023-10-26 00:00:00',
        'end_time' => '2023-10-27 00:00:00'
    ],
    'promotion_info' => [
        'promotion_name' => 'My Promotion'
    ]
];

// Create the order
$response = $client->orderCreate($params);

// Process the response
print_r($response);

?>
```

--------------------------------

### Query Financial Transaction Details - Curl Example

Source: https://open.oceanengine.com/docs/1780627317170250

This cURL command shows how to make a GET request to retrieve financial transaction details. It includes essential parameters like advertiser ID, date range, and transaction type, along with the required Access-Token header.

```bash
curl -X GET \
  'https://api.oceanengine.com/open_api/2/advertiser/fund/transaction/get/?advertiser_id=1234567890&start_date=2023-01-01&end_date=2023-12-31&transaction_type=RECHARGE&page=1&page_size=10' \
  -H 'Access-Token: YOUR_ACCESS_TOKEN'
```

--------------------------------

### Node.js SDK Example for Creating an Order

Source: https://open.oceanengine.com/tools/visual_debug.html?docId=1794677902211227

Example of how to use the Node.js SDK to create an order. This snippet shows the asynchronous approach to making the API call.

```javascript
const { DouplusApi } = require('@oceanengine/sdk');

// Initialize the API client
const client = new DouplusApi('YOUR_ACCESS_TOKEN');

// Define order parameters
const orderParams = {
    advertiser_id: 1234567890,
    order_info: {
        project_id: 'your_project_id',
        order_type: 'BUDGET',
        budget: 1000.00,
        start_time: '2023-10-26 00:00:00',
        end_time: '2023-10-27 00:00:00'
    },
    promotion_info: {
        promotion_name: 'My Promotion'
    }
};

// Create the order
client.orderCreate(orderParams)
    .then(response => {
        // Process the response
        console.log(response);
    })
    .catch(error => {
        console.error('Error creating order:', error);
    });
```

--------------------------------

### 创建项目

Source: https://open.oceanengine.com/labels/7/docs/1738862409262084

Creates a new marketing project with specified details.

```APIDOC
## POST /open_oceanengine/api/v1/project/create

### Description
Creates a new marketing project, allowing you to define campaign objectives, targeting, and budget.

### Method
POST

### Endpoint
/open_oceanengine/api/v1/project/create

### Parameters
#### Request Body
- **project_name** (string) - Required - The name of the project.
- **objective** (string) - Required - The marketing objective for the project (e.g., BRAND_AWARENESS, CONVERSIONS).
- **budget** (number) - Optional - The total budget allocated for the project.
- **start_time** (string) - Optional - The start date and time for the project in ISO 8601 format.
- **end_time** (string) - Optional - The end date and time for the project in ISO 8601 format.

### Request Example
```json
{
  "project_name": "Summer Sale Campaign",
  "objective": "CONVERSIONS",
  "budget": 5000.00,
  "start_time": "2024-07-01T00:00:00Z",
  "end_time": "2024-07-31T23:59:59Z"
}
```

### Response
#### Success Response (200)
- **project_id** (string) - The unique identifier for the newly created project.

#### Response Example
```json
{
  "code": 0,
  "message": "Success",
  "data": {
    "project_id": "proj_abc123xyz789"
  }
}
```
```

--------------------------------

### API Response Example

Source: https://open.oceanengine.com/labels/7/docs/1816052658391124

An example of a successful API response.

```APIDOC
## API Response Example

### Description
This section provides an example of a successful API response.

### Response Example
```json
{
    "message": "OK",
    "code": 0,
    "data": {}
}
```
```

--------------------------------

### Comment Management - Get Comment Statistics

Source: https://open.oceanengine.com/labels/7/docs/1826461039581386

API to get comment statistics.

```APIDOC
## GET /comments/statistics

### Description
Retrieves statistics related to comments.

### Method
GET

### Endpoint
/comments/statistics

### Query Parameters
- **video_id** (string) - Optional - Filter statistics by video ID.
```

--------------------------------

### Go SDK Usage Guide

Source: https://open.oceanengine.com/labels/12/docs/1777555692984388

Instructions for integrating and using the Go SDK for OceanEngine Open Platform.

```APIDOC
## Go SDK Usage Guide

### Description
This guide details how to use the Go SDK to interact with the OceanEngine Open Platform.

### Repository
[https://github.com/oceanengine/ad_open_sdk_go](https://github.com/oceanengine/ad_open_sdk_go)

### Key Features
- Faster and smoother integration
- Easier code maintenance through reusable components
```

--------------------------------

### Tools - Get Douyin Authorization Relationship

Source: https://open.oceanengine.com/labels/7/docs/1732513335286795

API to get the Douyin authorization relationship.

```APIDOC
## Get Douyin Authorization Relationship

### Description
Retrieves information about the authorization relationship with Douyin.

### Method
GET

### Endpoint
/douyin/authorization/relationship
```

--------------------------------

### 创建项目

Source: https://open.oceanengine.com/docs/1841044864825417

Creates a new marketing project.

```APIDOC
## POST /open_oceanengine/v1/project/create

### Description
Creates a new marketing project with specified details such as name, budget, and targeting.

### Method
POST

### Endpoint
/open_oceanengine/v1/project/create

### Parameters
#### Request Body
- **advertiser_id** (long) - Required - The ID of the advertiser.
- **project_name** (string) - Required - The name of the project.
- **budget** (float) - Required - The budget allocated for the project.
- **start_time** (string) - Required - The start date and time for the project (YYYY-MM-DD HH:MM:SS).
- **end_time** (string) - Required - The end date and time for the project (YYYY-MM-DD HH:MM:SS).
- **targeting** (object) - Optional - Targeting parameters for the project.
  - **location** (array) - List of locations to target.
  - **age_range** (array) - Age range for targeting.
  - **gender** (string) - Gender for targeting ('MALE', 'FEMALE', 'ALL').

### Request Example
{
  "advertiser_id": 1234567890,
  "project_name": "Summer Sale Campaign",
  "budget": 5000.00,
  "start_time": "2024-07-01 00:00:00",
  "end_time": "2024-07-31 23:59:59",
  "targeting": {
    "location": ["CN-BJ"],
    "age_range": ["18-35"],
    "gender": "ALL"
  }
}

### Response
#### Success Response (200)
- **project_id** (long) - The ID of the newly created project.

#### Response Example
{
  "code": 0,
  "message": "OK",
  "data": {
    "project_id": 9876543210
  }
}
```

--------------------------------

### Tools - Get Recommended Video Material

Source: https://open.oceanengine.com/labels/7/docs/1773102677218368

API to get recommended video materials.

```APIDOC
## GET /tools/creatives/recommended_video_material

### Description
Retrieves recommended video materials.

### Method
GET

### Endpoint
/tools/creatives/recommended_video_material
```

--------------------------------

### Java SDK Usage Guide

Source: https://open.oceanengine.com/labels/12/docs/1777555692984388

Instructions for integrating and using the Java SDK for OceanEngine Open Platform.

```APIDOC
## Java SDK Usage Guide

### Description
This guide details how to use the Java SDK to interact with the OceanEngine Open Platform.

### Repository
[https://github.com/oceanengine/ad_open_sdk_java](https://github.com/oceanengine/ad_open_sdk_java)

### Key Features
- Faster and smoother integration
- Easier code maintenance through reusable components
```

--------------------------------

### Tools - Get Recommended Video Materials

Source: https://open.oceanengine.com/docs/1789500809829388

API to get recommended video materials.

```APIDOC
## GET /tools/creative/recommended_video_materials

### Description
Retrieves recommended video materials.

### Method
GET

### Endpoint
/tools/creative/recommended_video_materials
```

--------------------------------

### Tools - Get Estimated CPC

Source: https://open.oceanengine.com/docs/1696710526682112

API to get the estimated cost per click.

```APIDOC
## GET /tools/cpc/estimated

### Description
Provides an estimation of the cost per click for advertising.

### Method
GET

### Endpoint
/tools/cpc/estimated

### Query Parameters
- **campaignId** (string) - Optional - The ID of the campaign.
- **adgroupId** (string) - Optional - The ID of the ad group.
```

--------------------------------

### Create Order API Request Body Example

Source: https://open.oceanengine.com/tools/visual_debug.html?docId=1794677902211227

This is an example of the request body for the 'Create Order' API. It includes fields like marketing_goal, aweme_id, item_id, external_action, delivery_time, and budget. Ensure all required fields are correctly populated.

```json
{
  "aweme_sec_uid": "",
  "object_infos": [
    {
      "marketing_goal": "VIDEO_PROM_GOODS",
      "aweme_id": "",
      "item_id": ""
    }
  ],
  "external_action": "LIKE_COMMENT_AMOUNT",
  "delivery_time": {},
  "budget": ""
}
```

--------------------------------

### 创建项目

Source: https://open.oceanengine.com/labels/7/docs/1714057019136013

Creates a new advertising project.

```APIDOC
## POST /open_oceanengine/v1/project/create

### Description
Creates a new advertising project.

### Method
POST

### Endpoint
/open_oceanengine/v1/project/create

### Parameters
#### Request Body
- **advertiser_id** (string) - Required - The ID of the advertiser.
- **project_name** (string) - Required - The name of the project.
- **budget** (number) - Optional - The budget for the project.
- **start_time** (string) - Optional - The start time of the project (YYYY-MM-DD HH:MM:SS).
- **end_time** (string) - Optional - The end time of the project (YYYY-MM-DD HH:MM:SS).

### Response
#### Success Response (200)
- **data** (object)
  - **project_id** (string) - The ID of the created project.

#### Response Example
```json
{
  "code": 0,
  "message": "OK",
  "data": {
    "project_id": "9876543210"
  }
}
```
```

--------------------------------

### Behavior Interest - Get Recommended Keywords

Source: https://open.oceanengine.com/labels/7

API to get recommended behavior or interest keywords.

```APIDOC
## GET /behavior_interest/recommended_keywords

### Description
Retrieves recommended behavior or interest keywords.

### Method
GET

### Endpoint
/behavior_interest/recommended_keywords

### Query Parameters
- **type** (string) - Required - The type of keywords to retrieve (behavior or interest).
- **category_id** (string) - Optional - Filter by category ID.
```

--------------------------------

### 创建项目

Source: https://open.oceanengine.com/docs/1710414664846349

Creates a new project for advertising campaigns.

```APIDOC
## 创建项目

### Description
Creates a new project for advertising campaigns.

### Method
POST

### Endpoint
/open_oceanengine/v1/project/create

### Parameters
#### Request Body
- **advertiser_id** (long) - Required - Advertiser ID
- **project_name** (string) - Required - Name of the project
- **budget** (number) - Optional - Budget for the project
- **start_time** (string) - Optional - Project start time (YYYY-MM-DD)
- **end_time** (string) - Optional - Project end time (YYYY-MM-DD)

### Response
#### Success Response (200)
- **data** (object) - Response data
  - **project_id** (long) - ID of the created project
```

--------------------------------

### Douyin Talent - Get Diagnostic Suggestions

Source: https://open.oceanengine.com/labels/7/docs/1732513335286795

API to get diagnostic suggestions for account performance.

```APIDOC
## Get Diagnostic Suggestions

### Description
Provides suggestions for improving account performance based on diagnostics.

### Method
GET

### Endpoint
/diagnostics/suggestions/get
```

--------------------------------

### Douyin Influencer - Get Diagnosis Suggestions

Source: https://open.oceanengine.com/labels/7/docs/1714057019136013

API to get diagnosis suggestions for Douyin influencers.

```APIDOC
## GET /douyin_influencer/diagnosis/suggestions

### Description
Retrieves diagnosis suggestions for Douyin influencers.

### Method
GET

### Endpoint
/douyin_influencer/diagnosis/suggestions
```

--------------------------------

### 项目管理模块

Source: https://open.oceanengine.com/labels/37/docs/1803720592156800

Manage local push advertising projects, including creation, updates, status changes, and retrieving lists of available stores, products, and Douyin accounts.

```APIDOC
## 创建项目

### Description
Creates a new local push advertising project.

### Method
POST

### Endpoint
/projects

### Request Body
- **project_name** (string) - Required - The name of the project.
- **budget** (number) - Optional - The budget for the project.
- **start_time** (string) - Optional - The start time for the project (YYYY-MM-DD HH:MM:SS).
- **end_time** (string) - Optional - The end time for the project (YYYY-MM-DD HH:MM:SS).

### Response
#### Success Response (200)
- **project_id** (string) - The ID of the created project.

### Request Example
{
  "project_name": "My Local Push Project",
  "budget": 10000,
  "start_time": "2024-01-01 00:00:00",
  "end_time": "2024-12-31 23:59:59"
}
```

```APIDOC
## 更新项目

### Description
Updates an existing local push advertising project.

### Method
PUT

### Endpoint
/projects/{project_id}

### Parameters
#### Path Parameters
- **project_id** (string) - Required - The ID of the project to update.

### Request Body
- **budget** (number) - Optional - The updated budget for the project.
- **start_time** (string) - Optional - The updated start time for the project (YYYY-MM-DD HH:MM:SS).
- **end_time** (string) - Optional - The updated end time for the project (YYYY-MM-DD HH:MM:SS).

### Response
#### Success Response (200)
- **message** (string) - Indicates the project was updated successfully.
```

```APIDOC
## 获取项目列表

### Description
Retrieves a list of local push advertising projects.

### Method
GET

### Endpoint
/projects

### Query Parameters
- **page** (integer) - Optional - The page number for pagination.
- **page_size** (integer) - Optional - The number of items per page.

### Response
#### Success Response (200)
- **projects** (array) - A list of project objects.
  - **project_id** (string) - The ID of the project.
  - **project_name** (string) - The name of the project.
  - **budget** (number) - The budget of the project.
  - **start_time** (string) - The start time of the project.
  - **end_time** (string) - The end time of the project.
```

```APIDOC
## 获取项目详情

### Description
Retrieves the details of a specific local push advertising project.

### Method
GET

### Endpoint
/projects/{project_id}

### Parameters
#### Path Parameters
- **project_id** (string) - Required - The ID of the project to retrieve.

### Response
#### Success Response (200)
- **project_id** (string) - The ID of the project.
- **project_name** (string) - The name of the project.
- **budget** (number) - The budget of the project.
- **start_time** (string) - The start time of the project.
- **end_time** (string) - The end time of the project.
```

```APIDOC
## 批量更新项目状态

### Description
Performs a batch update on the status of local push advertising projects.

### Method
PUT

### Endpoint
/projects/batch_status

### Request Body
- **project_ids** (array) - Required - A list of project IDs to update.
- **status** (string) - Required - The new status to set for the projects (e.g., "ENABLE", "DISABLE").

### Response
#### Success Response (200)
- **message** (string) - Indicates the batch update was successful.
```

```APIDOC
## 获取可投门店列表

### Description
Retrieves a list of stores that are available for local push advertising.

### Method
GET

### Endpoint
/stores/available

### Query Parameters
- **project_id** (string) - Required - The ID of the project for which to get available stores.

### Response
#### Success Response (200)
- **stores** (array) - A list of available store objects.
  - **store_id** (string) - The ID of the store.
  - **store_name** (string) - The name of the store.
```

```APIDOC
## 获取可投商品列表

### Description
Retrieves a list of products that are available for local push advertising.

### Method
GET

### Endpoint
/products/available

### Query Parameters
- **project_id** (string) - Required - The ID of the project for which to get available products.

### Response
#### Success Response (200)
- **products** (array) - A list of available product objects.
  - **product_id** (string) - The ID of the product.
  - **product_name** (string) - The name of the product.
```

```APIDOC
## 获取本地推创编可用抖音号

### Description
Retrieves a list of Douyin (TikTok) accounts that can be used for local push advertising creatives.

### Method
GET

### Endpoint
/douyin_accounts/available

### Query Parameters
- **project_id** (string) - Required - The ID of the project.

### Response
#### Success Response (200)
- **douyin_accounts** (array) - A list of available Douyin account objects.
  - **account_id** (string) - The ID of the Douyin account.
  - **account_name** (string) - The name of the Douyin account.
```

```APIDOC
## 查询本地推创编可用人群包

### Description
Queries for available audience packages that can be used for local push advertising creatives.

### Method
GET

### Endpoint
/audience_packages/available

### Query Parameters
- **project_id** (string) - Required - The ID of the project.

### Response
#### Success Response (200)
- **audience_packages** (array) - A list of available audience package objects.
  - **package_id** (string) - The ID of the audience package.
  - **package_name** (string) - The name of the audience package.
```

```APIDOC
## 根据多门店ID拉取门店ID

### Description
Retrieves store IDs based on a list of provided store IDs.

### Method
POST

### Endpoint
/stores/batch_get_ids

### Request Body
- **store_ids** (array) - Required - A list of store IDs.

### Response
#### Success Response (200)
- **store_ids** (array) - A list of valid store IDs.
```

```APIDOC
## 获取可用留资组件列表

### Description
Retrieves a list of available lead generation components.

### Method
GET

### Endpoint
/lead_generation/components

### Response
#### Success Response (200)
- **components** (array) - A list of lead generation component objects.
  - **component_id** (string) - The ID of the component.
  - **component_name** (string) - The name of the component.
```

```APIDOC
## 获取可用留资组件详情

### Description
Retrieves the details of a specific lead generation component.

### Method
GET

### Endpoint
/lead_generation/components/{component_id}

### Parameters
#### Path Parameters
- **component_id** (string) - Required - The ID of the lead generation component.

### Response
#### Success Response (200)
- **component_id** (string) - The ID of the component.
- **component_name** (string) - The name of the component.
- **details** (object) - Detailed information about the component.
```

```APIDOC
## 获取可用营销页列表

### Description
Retrieves a list of available marketing pages.

### Method
GET

### Endpoint
/marketing_pages/available

### Response
#### Success Response (200)
- **marketing_pages** (array) - A list of marketing page objects.
  - **page_id** (string) - The ID of the marketing page.
  - **page_name** (string) - The name of the marketing page.
```

```APIDOC
## 查询营销页详情

### Description
Retrieves the details of a specific marketing page.

### Method
GET

### Endpoint
/marketing_pages/{page_id}

### Parameters
#### Path Parameters
- **page_id** (string) - Required - The ID of the marketing page.

### Response
#### Success Response (200)
- **page_id** (string) - The ID of the marketing page.
- **page_name** (string) - The name of the marketing page.
- **url** (string) - The URL of the marketing page.
```

```APIDOC
## 获取私信接待抖音号

### Description
Retrieves Douyin (TikTok) accounts that can receive private messages for local push advertising.

### Method
GET

### Endpoint
/douyin_accounts/private_message_reception

### Response
#### Success Response (200)
- **douyin_accounts** (array) - A list of Douyin account objects capable of private message reception.
  - **account_id** (string) - The ID of the Douyin account.
  - **account_name** (string) - The name of the Douyin account.
```

```APIDOC
## 列表批量更新项目投放时段

### Description
Performs a batch update on the advertising time slots for local push advertising projects.

### Method
PUT

### Endpoint
/projects/batch_time_slots

### Request Body
- **project_ids** (array) - Required - A list of project IDs to update.
- **time_slots** (array) - Required - A list of time slot objects to set for the projects.
  - **start_time** (string) - Required - The start time of the slot (HH:MM).
  - **end_time** (string) - Required - The end time of the slot (HH:MM).
  - **days** (array) - Required - A list of days of the week (e.g., "MONDAY", "TUESDAY").

### Response
#### Success Response (200)
- **message** (string) - Indicates the batch update was successful.
```

--------------------------------

### API Response Example

Source: https://open.oceanengine.com/docs/1696710526192652

This is an example of a successful API response, indicating a '200 OK' status and a JSON object containing account details.

```http
HTTPS/1.1 200 OK
```

```json
{
    {
        "message": "OK",
        "code": 0,
        "data": {
            "advertiser_id": xxx,
            "name": "xxx",
            "emal": "xxx",
            "balance": 0,
            "valid_balance": 0,
            "cash": 0,
            "valid_cash": 0,
            "grant": 0,
            "union_grant": 0,
            "search_grant": 0,
            "common_grant": 0,
            "default_grant": 0,
            "valid_grant": 0
        },
        "request_id": "×××"
    }
}
```

--------------------------------

### Interactive Marketing - Get Work Scenarios

Source: https://open.oceanengine.com/labels/7/docs/1696710526192652

API to get work scenarios for interactive marketing.

```APIDOC
## GET /interactive_marketing/work_scenarios

### Description
Retrieves a list of available work scenarios for interactive marketing campaigns.

### Method
GET

### Endpoint
/interactive_marketing/work_scenarios
```

--------------------------------

### Tools - Get Recommended Video Materials

Source: https://open.oceanengine.com/labels/7/docs/1696710508029967

API to get recommended video materials for creatives.

```APIDOC
## GET /tools/creative/recommended_videos

### Description
Retrieves recommended video materials suitable for creatives.

### Method
GET

### Endpoint
/tools/creative/recommended_videos

### Query Parameters
- **campaign_id** (string) - Optional - The ID of the campaign to get recommendations for.
```

--------------------------------

### Tools - Get Marketing Preview QR Code (Upgrade Version)

Source: https://open.oceanengine.com/labels/7/docs/1847394521222599

API to get the marketing preview QR code for the upgrade version.

```APIDOC
## GET /tools/marketing/preview_qrcode

### Description
Gets the marketing preview QR code for the upgrade version.

### Method
GET

### Endpoint
/tools/marketing/preview_qrcode

### Query Parameters
- **campaign_id** (string) - Required - The ID of the campaign.
```

--------------------------------

### Tools - Get Recommended Video Materials

Source: https://open.oceanengine.com/labels/7/docs/1696710526192652

API to get recommended video materials for creatives.

```APIDOC
## GET /tools/creative/recommended_videos

### Description
Retrieves a list of recommended video materials suitable for creative use.

### Method
GET

### Endpoint
/tools/creative/recommended_videos
```

--------------------------------

### Tools - Get Recommended Video Materials

Source: https://open.oceanengine.com/docs/1860068101111872

API to get recommended video materials for creation.

```APIDOC
## GET /tools/recommended_video_materials

### Description
Retrieves recommended video materials for creation.

### Method
GET

### Endpoint
/tools/recommended_video_materials

### Query Parameters
- **campaign_id** (string) - Required - The ID of the campaign.
```

--------------------------------

### API Response Example

Source: https://open.oceanengine.com/docs/1710414664846349

This is a sample JSON response from the Open OceanEngine API, illustrating a successful request with application data and pagination details.

```http
HTTPS/1.1 200 OK
```

```json
{
    "code": 0,
    "message": "OK",
    "request_id": "202109091709440102122040202A4806AA",
    "data": {
        "list": [
            {
                "app_cloud_id": 1,
                "app_name": "xxx",
                "create_time": "2020-07-29 08:17:59",
                "download_url": "https://apps.bytesfield.com/download/basic/cur/xxx",
                "icon_url": "https://xxx.xxx.xxx/xxx",
                "package_id": "xxx",
                "package_name": "com.xxx.xxx",
                "publish_time": "2021-03-14 03:43:16",
                "update_time": "2021-08-09 09:07:25",
                "version": "1.6.1"
            }
        ],
        "page_info": {
            "page": 1,
            "page_size": 1,
            "total_number": 14,
            "total_page": 14
        }
    }
}
```

--------------------------------

### One-Click Boost - Get Recommended Boost Budget

Source: https://open.oceanengine.com/labels/7/docs/1773089427219584

Retrieves recommended budget for one-click boost.

```APIDOC
## GET /one_click_boost/marketing/budget/recommended

### Description
Retrieves the recommended budget for one-click boost in marketing campaigns (Marketing Upgrade Edition).

### Method
GET

### Endpoint
/one_click_boost/marketing/budget/recommended

### Query Parameters
- **campaign_id** (string) - Required - The ID of the campaign.
```

--------------------------------

### API Response Example

Source: https://open.oceanengine.com/labels/7/docs/1738862409262084

An example of a successful API response, including the HTTP status and JSON body.

```APIDOC
## API Response Example

### Success Response (200 OK)

```json
{
    "message": "OK",
    "code": 0,
    "data": {}
}
```
```

--------------------------------

### 创建橙子建站站点

Source: https://open.oceanengine.com/labels/7/docs/1714057019136013

Creates a new site using the Chenzi Website Builder.

```APIDOC
## POST /open_oceanengine/v1/site/chenzi/create

### Description
Creates a new site using the Chenzi Website Builder.

### Method
POST

### Endpoint
/open_oceanengine/v1/site/chenzi/create

### Parameters
#### Request Body
- **advertiser_id** (string) - Required - The ID of the advertiser.
- **site_name** (string) - Required - The name of the site.
- **template_id** (string) - Optional - The ID of the template to use.

### Response
#### Success Response (200)
- **data** (object)
  - **site_id** (string) - The ID of the created site.

#### Response Example
```json
{
  "code": 0,
  "message": "OK",
  "data": {
    "site_id": "site12345"
  }
}
```
```

--------------------------------

### One-Click Boosting (Upgrade) - Get Marketing Boosting Status

Source: https://open.oceanengine.com/labels/7/docs/1847119758118924

API to get the status of marketing boosting.

```APIDOC
## GET /marketing/one_click_boosting/status

### Description
Retrieves the current status of marketing boosting tasks.

### Method
GET

### Endpoint
/marketing/one_click_boosting/status

### Query Parameters
- **campaign_id** (string) - Optional - Filter by campaign ID.
```

--------------------------------

### Tools - Get Quick Promote Recommended Bid Coefficient

Source: https://open.oceanengine.com/docs/1696710519607296

Retrieves recommended bid coefficients for quick promotion.

```APIDOC
## GET /tools/quick_promote/bid_coefficient

### Description
Retrieves recommended bid coefficients for the quick promotion feature.

### Method
GET

### Endpoint
/tools/quick_promote/bid_coefficient
```

--------------------------------

### Tools - Get Marketing Preview QR Code (Upgrade Edition)

Source: https://open.oceanengine.com/labels/7/docs/1696710502277120

Generates a QR code for marketing preview.

```APIDOC
## GET /tools/marketing-preview-qrcode

### Description
Generates a QR code for previewing marketing campaigns (Marketing Upgrade Edition).

### Method
GET

### Endpoint
/tools/marketing-preview-qrcode

### Parameters
#### Query Parameters
- **campaign_id** (string) - Required - The ID of the campaign to preview.
```

--------------------------------

### One-Click Creative Boosting - Get Creative Boosting Status

Source: https://open.oceanengine.com/labels/7/docs/1732513335286795

API to get the status of creative boosting.

```APIDOC
## Get Creative Boosting Status

### Description
Retrieves the current status of creative boosting for specific creatives.

### Method
GET

### Endpoint
/creative_boost/status

### Query Parameters
- **creative_ids** (array) - Required - A list of creative IDs to check the status for.
```

--------------------------------

### One-Click Boosting (Upgraded) - Get Recommended Boosting Budget

Source: https://open.oceanengine.com/labels/7/docs/1696710505596940

Retrieves the recommended budget for one-click boosting.

```APIDOC
## GET /one_click_boosting/marketing/budget

### Description
Gets the recommended boosting budget (for the upgraded version of JuLiang Marketing).

### Method
GET

### Endpoint
/one_click_boosting/marketing/budget
```

--------------------------------

### Douyin Talent - Get Unit Diagnostic Suggestions

Source: https://open.oceanengine.com/labels/7/docs/1732513335286795

API to get diagnostic suggestions for specific units.

```APIDOC
## Get Unit Diagnostic Suggestions

### Description
Retrieves diagnostic suggestions specific to advertising units.

### Method
GET

### Endpoint
/diagnostics/unit/suggestions/get
```

--------------------------------

### Tools - Get Recommended Douyin Video Materials

Source: https://open.oceanengine.com/labels/7/docs/1714057253379079

API to get recommended Douyin video materials.

```APIDOC
## GET /tools/recommended_douyin_materials/video

### Description
Gets recommended Douyin video materials.

### Method
GET

### Endpoint
/tools/recommended_douyin_materials/video
```

--------------------------------

### 项目管理 - 创建项目

Source: https://open.oceanengine.com/labels/7/docs/1780614750260288

创建新的广告项目，用于组织和管理广告活动。

```APIDOC
## POST /open_oceanengine/v1/project/create

### Description
创建新的广告项目。

### Method
POST

### Endpoint
/open_oceanengine/v1/project/create

### Parameters
#### Request Body
- **advertiser_id** (long) - Required - 广告主ID
- **project_name** (string) - Required - 项目名称
- **budget** (float) - Optional - 项目预算

### Response
#### Success Response (200)
- **data** (object) - 返回数据
  - **project_id** (string) - 项目ID
```

--------------------------------

### One-Click Boosting for Creatives - Get Creative Boosting Status

Source: https://open.oceanengine.com/labels/7/docs/1714057019136013

API to get the status of creative boosting.

```APIDOC
## GET /creative_boosting/status

### Description
Retrieves the status of creative boosting.

### Method
GET

### Endpoint
/creative_boosting/status

### Query Parameters
- **creative_id** (string) - Required - The ID of the creative.
```

--------------------------------

### Get Advertiser List - Java SDK

Source: https://open.oceanengine.com/docs/1796368918556803

This Java SDK method allows you to fetch advertisers linked to a Zongheng Workstation. Requires an Access Token and the relevant cc_account_id.

```java
Map<String, Object> params = new HashMap<>();
params.put("cc_account_id", 12345L);
params.put("account_source", "QIANCHUAN");

Map<String, Object> filtering = new HashMap<>();
filtering.put("account_name", "test_account");
filtering.put("page", 1);
filtering.put("page_size", 10);
params.put("filtering", filtering);

CustomerCenterAdvertiserListResponse response = CustomerCenterAdvertiserList.get(params, "YOUR_ACCESS_TOKEN");
System.out.println(response);
```

--------------------------------

### Tools - Get Marketing Preview QR Code (Upgrade)

Source: https://open.oceanengine.com/labels/7/docs/1696710497745920

Generates a marketing preview QR code (upgrade version).

```APIDOC
## GET /tools/marketing/preview_qrcode

### Description
Generates a QR code for marketing preview. This is the upgrade version.

### Method
GET

### Endpoint
/tools/marketing/preview_qrcode

### Query Parameters
- **campaign_id** (string) - Required - The ID of the campaign to preview.
```

--------------------------------

### ChuanShanJia Traffic Package - Get ChuanShanJia Traffic Package

Source: https://open.oceanengine.com/labels/7/docs/1714057019136013

API to get ChuanShanJia traffic packages.

```APIDOC
## GET /csj_traffic_package/list

### Description
Retrieves ChuanShanJia traffic packages.

### Method
GET

### Endpoint
/csj_traffic_package/list
```

--------------------------------

### Douyin Influencer - Get Unit Diagnosis Suggestions

Source: https://open.oceanengine.com/labels/7/docs/1714057019136013

API to get diagnosis suggestions for specific units.

```APIDOC
## GET /douyin_influencer/diagnosis/unit_suggestions

### Description
Retrieves diagnosis suggestions for specific units.

### Method
GET

### Endpoint
/douyin_influencer/diagnosis/unit_suggestions

### Query Parameters
- **unit_id** (string) - Required - The ID of the unit.
```