summaryrefslogtreecommitdiff
path: root/data/en_us/retailadvqa/2019-10-27/api-docs.php
blob: c998f5027a4da87aba4ba330dcadd654e2633029 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
<?php return [
    'version' => '1.0',
    'info' => ['style' => 'RPC', 'product' => 'retailadvqa', 'version' => '2019-10-27'],
    'directories' => [
        [
            'id' => 0,
            'title' => '其它',
            'type' => 'directory',
            'children' => ['PushAudience', 'QueryAudienceStatus', 'QueryBrandList', 'PushAcknowledgeCrowd', 'PageIncrementMembers', 'PageMembers'],
        ],
    ],
    'components' => [
        'schemas' => [],
    ],
    'apis' => [
        'PushAudience' => [
            'methods' => ['post'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'readAndWrite',
            'deprecated' => false,
            'systemTags' => [],
            'parameters' => [
                [
                    'name' => 'CrowdId',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
                ],
                [
                    'name' => 'CrowdName',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
                ],
                [
                    'name' => 'CrowdCount',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '50000000000', 'minimum' => '0'],
                ],
                [
                    'name' => 'BrandId',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
                ],
                [
                    'name' => 'BrandName',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
                ],
                [
                    'name' => 'SmartName',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
                ],
                [
                    'name' => 'Uid',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'type' => 'object',
                        'properties' => [
                            'Data' => ['type' => 'string'],
                            'RequestId' => ['type' => 'string'],
                            'ErrorCode' => ['type' => 'string'],
                            'Success' => ['type' => 'boolean'],
                            'TraceId' => ['type' => 'string'],
                            'ErrorDesc' => ['type' => 'string'],
                        ],
                    ],
                ],
            ],
            'errorCodes' => [
                403 => [
                    ['errorCode' => 'AuthorizeFail', 'errorMessage' => 'Failed to authorize the API operation.'],
                ],
            ],
        ],
        'QueryAudienceStatus' => [
            'methods' => ['post'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'readAndWrite',
            'deprecated' => false,
            'systemTags' => [],
            'parameters' => [
                [
                    'name' => 'UploadId',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '0'],
                ],
                [
                    'name' => 'CrowdId',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
                ],
                [
                    'name' => 'Uid',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'type' => 'object',
                        'properties' => [
                            'RequestId' => ['type' => 'string'],
                            'TraceId' => ['type' => 'string'],
                            'Success' => ['type' => 'boolean'],
                            'ErrorCode' => ['type' => 'string'],
                            'ErrorDesc' => ['type' => 'string'],
                            'Data' => [
                                'type' => 'object',
                                'properties' => [
                                    'UploadId' => ['type' => 'integer', 'format' => 'int32'],
                                    'Status' => ['type' => 'string'],
                                    'CrowdId' => ['type' => 'string'],
                                ],
                            ],
                        ],
                    ],
                ],
            ],
            'errorCodes' => [
                403 => [
                    ['errorCode' => 'AuthorizeFail', 'errorMessage' => 'Failed to authorize the API operation.'],
                ],
            ],
        ],
        'QueryBrandList' => [
            'summary' => '查询品牌列表',
            'methods' => ['post'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'readAndWrite',
            'deprecated' => false,
            'systemTags' => [],
            'parameters' => [
                [
                    'name' => 'uid',
                    'in' => 'query',
                    'schema' => ['type' => 'string'],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'title' => 'Schema of Response',
                        'type' => 'object',
                        'properties' => [
                            'RequestId' => ['title' => 'Id of the request', 'type' => 'string'],
                            'Data' => [
                                'type' => 'array',
                                'items' => [
                                    'type' => 'object',
                                    'properties' => [
                                        'BrandName' => ['type' => 'string'],
                                        'SmartName' => ['type' => 'string'],
                                    ],
                                ],
                            ],
                            'ErrorCode' => ['type' => 'string'],
                            'Success' => ['type' => 'boolean'],
                            'ErrorDesc' => ['type' => 'string'],
                            'TraceId' => ['type' => 'string'],
                        ],
                    ],
                ],
            ],
        ],
        'PushAcknowledgeCrowd' => [
            'summary' => 'A人群回流接口',
            'methods' => ['post'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'readAndWrite',
            'deprecated' => false,
            'systemTags' => [],
            'parameters' => [
                [
                    'name' => 'CrowdId',
                    'in' => 'query',
                    'schema' => ['type' => 'string'],
                ],
                [
                    'name' => 'CrowdCount',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int64'],
                ],
                [
                    'name' => 'BrandId',
                    'in' => 'query',
                    'schema' => ['type' => 'string'],
                ],
                [
                    'name' => 'BrandName',
                    'in' => 'query',
                    'schema' => ['type' => 'string'],
                ],
                [
                    'name' => 'SmartName',
                    'in' => 'query',
                    'schema' => ['type' => 'string'],
                ],
                [
                    'name' => 'Uid',
                    'in' => 'query',
                    'schema' => ['type' => 'string'],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'title' => 'Schema of Response',
                        'type' => 'object',
                        'properties' => [
                            'RequestId' => ['title' => 'Id of the request', 'type' => 'string'],
                            'Data' => ['type' => 'string'],
                            'ErrorCode' => ['type' => 'string'],
                            'Success' => ['type' => 'boolean'],
                            'TraceId' => ['type' => 'string'],
                            'ErrorDesc' => ['type' => 'string'],
                        ],
                    ],
                ],
            ],
        ],
        'PageIncrementMembers' => [
            'summary' => '按照时间段分页获取会员新增数据接口',
            'methods' => ['post'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'deprecated' => false,
            'systemTags' => [],
            'parameters' => [
                [
                    'name' => 'body',
                    'in' => 'query',
                    'allowEmptyValue' => true,
                    'style' => 'json',
                    'schema' => [
                        'type' => 'object',
                        'properties' => [
                            'OpenMerchantId' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => '750cff00c3e0996d220ac2861dafdfadsf'],
                            'StartModifiedTime' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => '2023-04-17 00:00:00'],
                            'EndModifiedTime' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => '2023-04-18 00:00:00'."\n"],
                            'PageNo' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => '1'],
                            'PageSize' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => '10'],
                        ],
                        'required' => false,
                    ],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'title' => 'Schema of Response',
                        'description' => 'Schema of Response',
                        'type' => 'object',
                        'properties' => [
                            'TotalCount' => ['title' => 'TotalCount本次请求条件下的数据总量,此参数为可选参数,默认可不返回', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '5000'],
                            'RequestId' => ['title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => '1DEFC4F1-AF11-5A3C-93B9-2880768DA218'."\n"],
                            'Success' => ['description' => '', 'type' => 'string', 'example' => 'true'],
                            'ErrorCode' => ['description' => '', 'type' => 'string', 'example' => 'Lydaas.QuickMember.SystemError'."\n"],
                            'ErrorMessage' => ['description' => '', 'type' => 'string', 'example' => ''],
                            'Data' => [
                                'description' => '',
                                'type' => 'array',
                                'items' => [
                                    'type' => 'object',
                                    'properties' => [
                                        'OpenMerchantId' => ['description' => '', 'type' => 'string', 'example' => '750cff00c3e0996d220ac2861dafdfadsf'],
                                        'OuterMemberId' => ['description' => '', 'type' => 'string', 'example' => 'MEMBER_fc498a12edd84dafd'],
                                        'Name' => ['description' => '', 'type' => 'string', 'example' => 'Empti_Tier'],
                                        'Mobile' => ['description' => '', 'type' => 'string', 'example' => '13999999999'],
                                        'MixMobile' => ['description' => '', 'type' => 'string', 'example' => 'dfafaswsdfdfdsga'],
                                        'Birthday' => ['description' => '', 'type' => 'string', 'example' => '1992-04-17'],
                                        'Province' => ['description' => '', 'type' => 'string', 'example' => ''],
                                        'City' => ['description' => '', 'type' => 'string', 'example' => ''],
                                        'Sex' => ['description' => '', 'type' => 'string', 'example' => ''],
                                        'Email' => ['description' => '', 'type' => 'string', 'example' => 'dfasdfa@qq.com'],
                                        'LevelNum' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
                                        'LevelPoints' => ['description' => '', 'type' => 'string', 'example' => '99'],
                                        'ConsumePoints' => ['description' => '', 'type' => 'string', 'example' => '999'],
                                        'SiteUsers' => ['description' => '', 'type' => 'string', 'example' => '[{\\"omid\\": null, \\"ouid\\": null, \\"openUserId\\": \\"ddajkajdlf-dfasdfq24r\\", \\"channelCode\\": \\"taobao\\"}]'."\n"],
                                    ],
                                ],
                            ],
                        ],
                    ],
                ],
            ],
            'errorCodes' => [
                403 => [
                    ['errorCode' => 'AuthorizeFail', 'errorMessage' => 'Failed to authorize the API operation.'],
                ],
            ],
            'staticInfo' => ['returnType' => 'synchronous'],
            'responseDemo' => '[{"errorExample":"","example":"{\\n  \\"TotalCount\\": 5000,\\n  \\"RequestId\\": \\"1DEFC4F1-AF11-5A3C-93B9-2880768DA218\\\\n\\",\\n  \\"Success\\": \\"true\\",\\n  \\"ErrorCode\\": \\"Lydaas.QuickMember.SystemError\\\\n\\",\\n  \\"ErrorMessage\\": \\"系统错误: openMerchantId 不能为空\\\\n\\",\\n  \\"Data\\": [\\n    {\\n      \\"OpenMerchantId\\": \\"750cff00c3e0996d220ac2861dafdfadsf\\",\\n      \\"OuterMemberId\\": \\"MEMBER_fc498a12edd84dafd\\",\\n      \\"Name\\": \\"Empti_Tier\\",\\n      \\"Mobile\\": \\"13999999999\\",\\n      \\"MixMobile\\": \\"dfafaswsdfdfdsga\\",\\n      \\"Birthday\\": \\"1992-04-17\\",\\n      \\"Province\\": \\"浙江\\",\\n      \\"City\\": \\"杭州\\",\\n      \\"Sex\\": \\"男\\",\\n      \\"Email\\": \\"dfasdfa@qq.com\\",\\n      \\"LevelNum\\": 2,\\n      \\"LevelPoints\\": \\"99\\",\\n      \\"ConsumePoints\\": \\"999\\",\\n      \\"SiteUsers\\": \\"[{\\\\\\\\\\\\\\"omid\\\\\\\\\\\\\\": null, \\\\\\\\\\\\\\"ouid\\\\\\\\\\\\\\": null, \\\\\\\\\\\\\\"openUserId\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"ddajkajdlf-dfasdfq24r\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"channelCode\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"taobao\\\\\\\\\\\\\\"}]\\\\n\\"\\n    }\\n  ]\\n}","type":"json"}]',
        ],
        'PageMembers' => [
            'summary' => '按照时间分页获取会员数据接口',
            'methods' => ['post'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'deprecated' => false,
            'systemTags' => [],
            'parameters' => [
                [
                    'name' => 'body',
                    'in' => 'query',
                    'style' => 'json',
                    'schema' => [
                        'description' => '',
                        'type' => 'object',
                        'properties' => [
                            'OpenMerchantId' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => '750cff00c3e0996d220ac2861dafdfadsf'],
                            'EndCreatedTime' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => '2023-04-17 00:00:00'],
                            'PageNo' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
                            'PageSize' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
                        ],
                        'required' => false,
                    ],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'title' => 'Schema of Response',
                        'description' => 'Schema of Response',
                        'type' => 'object',
                        'properties' => [
                            'TotalCount' => ['title' => 'TotalCount本次请求条件下的数据总量,此参数为可选参数,默认可不返回', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '5000'],
                            'RequestId' => ['description' => '', 'type' => 'string', 'example' => '1DEFC4F1-AF11-5A3C-93B9-2880768DA218'],
                            'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
                            'ErrorCode' => ['description' => '', 'type' => 'string', 'example' => 'Lydaas.QuickMember.SystemError'],
                            'ErrorMessage' => ['description' => '', 'type' => 'string', 'example' => ''],
                            'Data' => [
                                'description' => '',
                                'type' => 'array',
                                'items' => [
                                    'type' => 'object',
                                    'properties' => [
                                        'OpenMerchantId' => ['description' => '', 'type' => 'string', 'example' => '750cff00c3e0996d220ac2861dafdfadsf'."\n"],
                                        'OuterMemberId' => ['description' => '', 'type' => 'string', 'example' => 'MEMBER_fc498a12edd84dafd'],
                                        'Name' => ['description' => '', 'type' => 'string', 'example' => ''],
                                        'Mobile' => ['description' => '', 'type' => 'string', 'example' => '13999999999'],
                                        'MixMobile' => ['description' => '', 'type' => 'string', 'example' => 'fc498a12edd84dafdvdadfa'],
                                        'Birthday' => ['description' => '', 'type' => 'string', 'example' => '1992-04-17'],
                                        'Province' => ['description' => '', 'type' => 'string', 'example' => ''],
                                        'City' => ['description' => '', 'type' => 'string', 'example' => ''],
                                        'Sex' => ['description' => '', 'type' => 'string', 'example' => ''],
                                        'Email' => ['description' => '', 'type' => 'string', 'example' => '112232312@qq.com'],
                                        'LevelNum' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
                                        'LevelPoints' => ['description' => '', 'type' => 'string', 'example' => '999'],
                                        'ConsumePoints' => ['description' => '', 'type' => 'string', 'example' => '9999'],
                                        'SiteUsers' => ['description' => '', 'type' => 'string', 'example' => '[{\\"omid\\": null, \\"ouid\\": null, \\"openUserId\\": \\"ddajkajdlf-dfasdfq24r\\", \\"channelCode\\": \\"taobao\\"}]'],
                                    ],
                                ],
                            ],
                        ],
                    ],
                ],
            ],
            'errorCodes' => [
                403 => [
                    ['errorCode' => 'AuthorizeFail', 'errorMessage' => 'Failed to authorize the API operation.'],
                ],
            ],
            'staticInfo' => ['returnType' => 'synchronous'],
            'responseDemo' => '[{"errorExample":"","example":"{\\n  \\"TotalCount\\": 5000,\\n  \\"RequestId\\": \\"1DEFC4F1-AF11-5A3C-93B9-2880768DA218\\",\\n  \\"Success\\": true,\\n  \\"ErrorCode\\": \\"Lydaas.QuickMember.SystemError\\",\\n  \\"ErrorMessage\\": \\"系统错误: openMerchantId 不能为空\\",\\n  \\"Data\\": [\\n    {\\n      \\"OpenMerchantId\\": \\"750cff00c3e0996d220ac2861dafdfadsf\\\\n\\",\\n      \\"OuterMemberId\\": \\"MEMBER_fc498a12edd84dafd\\",\\n      \\"Name\\": \\"张三\\",\\n      \\"Mobile\\": \\"13999999999\\",\\n      \\"MixMobile\\": \\"fc498a12edd84dafdvdadfa\\",\\n      \\"Birthday\\": \\"1992-04-17\\",\\n      \\"Province\\": \\"浙江\\",\\n      \\"City\\": \\"杭州\\",\\n      \\"Sex\\": \\"男\\",\\n      \\"Email\\": \\"112232312@qq.com\\",\\n      \\"LevelNum\\": 1,\\n      \\"LevelPoints\\": \\"999\\",\\n      \\"ConsumePoints\\": \\"9999\\",\\n      \\"SiteUsers\\": \\"[{\\\\\\\\\\\\\\"omid\\\\\\\\\\\\\\": null, \\\\\\\\\\\\\\"ouid\\\\\\\\\\\\\\": null, \\\\\\\\\\\\\\"openUserId\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"ddajkajdlf-dfasdfq24r\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"channelCode\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"taobao\\\\\\\\\\\\\\"}]\\"\\n    }\\n  ]\\n}","type":"json"}]',
        ],
    ],
    'endpoints' => [
        ['regionId' => 'cn-shenzhen', 'endpoint' => 'quicka.cn-shenzhen.aliyuncs.com'],
        ['regionId' => 'cn-zhangjiakou', 'endpoint' => 'quicka.cn-zhangjiakou.aliyuncs.com'],
        ['regionId' => 'cn-shanghai', 'endpoint' => 'quicka.cn-shanghai.aliyuncs.com'],
    ],
];