发起请求

本节将为您介绍如何发起一次API请求。

请求URL

Marketing API 请求URL约定了使用的协议、域名、模块、版本、资源及动作，详细定义如下：

• 正式环境为 https://api.e.qq.com/<API_VERSION>/<RESOURCE_NAME>/<RESOURCE_ACTION>
• 沙箱环境为 https://sandbox-api.e.qq.com/<API_VERSION>/<RESOURCE_NAME>/<RESOURCE_ACTION>

其中：

• 协议：正式环境和沙箱环境均使用 HTTPS；
• API_VERSION：版本号，当前最新版本号为 v1.3；
• RESOURCE_NAME：表示要操作的资源，如campaigns、adcreatives；
• RESOURCE_ACTION：表示对资源的动作，如 get、add。

各接口对应的 <RESOURCE_NAME>/<RESOURCE_ACTION> 在文档中描述为接口请求路径，例如：正式环境新建一个推广计划，接口文档中描述的请求路径为 campaigns/add，完整地址为 https://api.e.qq.com/v1.3/campaigns/add。

HTTP Method

调用方应根据具体接口的要求设置 HTTP Method为 GET或POST。

HTTP Header

调用方应遵循HTTP协议设置相应的 Header，目前支持的Header有：Content-Type，用于指定数据格式。例如：

Content-Type: application/json

编码方式

Marketing API支持的编码方式为 UTF-8。

接口调用限制

特殊字符限制

如无特殊声明，API接口所有输入参数的值均不能包含以下这些特殊字符：< > & ‘ ” / \ 以及TAB、换行、回车键。

请求通用参数

1、每个请求接口中的均需传入以下通用参数，详细定义如下表所示：

2、所有get接口，请求参数中必须增加fields字段，用于指定返回的字段列表。

增加fields的接口以及默认值如下表：

完整请求示例

API请求中需要提供必要的通用参数、每个接口要求的参数，并声明正确的编码方式。以curl发起请求获取和创建一个推广计划为例。 获取一个推广计划：

curl 'https://api.e.qq.com/v1.1/campaigns/get?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
    -d 'account_id=51959'
    -d 'fields=[campaign_id,campaign_name,campaign_type, daily_budget]'

< HTTP/1.1 200 OK
< Content-Type: application/json; charset=utf-8
<
{ 
    code:0,
    message:，
    data:
    {
        list:[  
            {  
                campaign_id:12345,
                campaign_name:推广计划1,
                campaign_type:CAMPAIGN_TYPE_NORMAL,
                daily_budget:1000000
            },
            {  
                campaign_id:12346,
                campaign_name:推广计划2,
                campaign_type:CAMPAIGN_TYPE_NORMAL,
                daily_budget:10000
            },
       page_info:{  
            page:1,
            page_size:2,
            total_number:2,
            total_page:1
        }
    } 
}

创建一个推广计划：

curl 'https://api.e.qq.com/v1.1/campaigns/add?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
    -H 'Content-Type: application/json' \
    -d '{
        account_id: 51959,
        campaign_name: test,
        campaign_type: CAMPAIGN_TYPE_NORMAL,
        daily_budget: 10000,
        promoted_object_type,PROMOTED_OBJECT_TYPE_APP_IOS
    }'

* Connected to api.e.qq.com (10.10.10.10) port 443 (#0)

> POST / HTTP/1.1
> User-Agent: curl/7.41.0
> Host: api.e.qq.com
> Content-Type: application/json
> Content-Length: 64
* upload completely sent off: 64 out of 64 bytes

< HTTP/1.1 200 OK
< Content-Type: application/json; charset=utf-8
<
{ 
    code:0,
    message:，
    data:
    {
        campaign_id:23456
    } 
}