path: root/data/zh_cn/retailadvqa/2019-10-27/api-docs.php

<?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' => '商家加密品牌 ID',
                                'type' => 'string',
                                'required' => false,
                                'example' => '750cff00c3e0996d220ac2861dafdfadsf',
                            ],
                            'StartModifiedTime' => [
                                'description' => '查询修改开始时间(修改时间跨度不能大于一天)，格式:yyyy-MM-dd HH:mm:ss',
                                'type' => 'string',
                                'required' => false,
                                'example' => '2023-04-17 00:00:00',
                            ],
                            'EndModifiedTime' => [
                                'description' => '查询修改结束时间，必须大于修改开始时间(修改时间跨度不能大于一天)，格式:yyyy-MM-dd HH:mm:ss',
                                'type' => 'string',
                                'required' => false,
                                'example' => '2023-04-18 00:00:00'."\n",
                            ],
                            'PageNo' => [
                                'description' => '当前页，默认为：1',
                                'type' => 'string',
                                'required' => false,
                                'example' => '1',
                            ],
                            'PageSize' => [
                                'description' => '每页数量，默认40，最大40',
                                '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' => 'TotalCount本次请求条件下的数据总量',
                                'type' => 'integer',
                                'format' => 'int32',
                                'example' => '5000',
                            ],
                            'RequestId' => [
                                'title' => 'Id of the request',
                                'description' => '请求id，每次请求都是唯一值，便于后续排查问题',
                                'type' => 'string',
                                'example' => '1DEFC4F1-AF11-5A3C-93B9-2880768DA218'."\n",
                            ],
                            'Success' => [
                                'description' => '查询是否成功：'."\n"
                                    .'true：成功。                                '."\n"
                                    .'false：失败。',
                                'type' => 'string',
                                'example' => 'true',
                            ],
                            'ErrorCode' => [
                                'description' => '错误码',
                                'type' => 'string',
                                'example' => 'Lydaas.QuickMember.SystemError'."\n",
                            ],
                            'ErrorMessage' => [
                                'description' => '调用失败时，返回的错误信息。'."\n",
                                'type' => 'string',
                                'example' => '系统错误: openMerchantId 不能为空'."\n",
                            ],
                            'Data' => [
                                'description' => '请求接口返回的数据，会员列表',
                                'type' => 'array',
                                'items' => [
                                    'type' => 'object',
                                    'properties' => [
                                        'OpenMerchantId' => [
                                            'description' => '商家加密品牌 ID',
                                            'type' => 'string',
                                            'example' => '750cff00c3e0996d220ac2861dafdfadsf',
                                        ],
                                        'OuterMemberId' => [
                                            'description' => '商家会员ID',
                                            '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' => '[email protected]',
                                        ],
                                        '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\\": \\"[email protected]\\",\\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"}]',
            'title' => '查询品牌的增量会员数据（根据修改时间）',
        ],
        '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' => '商家加密品牌 ID',
                                'type' => 'string',
                                'required' => false,
                                'example' => '750cff00c3e0996d220ac2861dafdfadsf',
                            ],
                            'EndCreatedTime' => [
                                'description' => '会员注册结束时间，格式:yyyy-MM-dd HH:mm:ss，查询注册结束时间之前的会员记录',
                                'type' => 'string',
                                'required' => false,
                                'example' => '2023-04-17 00:00:00',
                            ],
                            'PageNo' => [
                                'description' => '当前页，默认为：**1**',
                                'type' => 'integer',
                                'format' => 'int32',
                                'required' => false,
                                'example' => '1',
                            ],
                            'PageSize' => [
                                'description' => '每页数量，默认40，最大40',
                                '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' => 'TotalCount本次请求条件下的数据总量',
                                'type' => 'integer',
                                'format' => 'int32',
                                'example' => '5000',
                            ],
                            'RequestId' => [
                                'description' => '请求id，每次请求都是唯一值，便于后续排查问题',
                                'type' => 'string',
                                'example' => '1DEFC4F1-AF11-5A3C-93B9-2880768DA218',
                            ],
                            'Success' => [
                                'description' => '查询是否成功：'."\n"
                                    .'true：成功。                                 '."\n"
                                    .'false：失败。',
                                'type' => 'boolean',
                                'example' => 'true',
                            ],
                            'ErrorCode' => [
                                'description' => '错误码',
                                'type' => 'string',
                                'example' => 'Lydaas.QuickMember.SystemError',
                            ],
                            'ErrorMessage' => [
                                'description' => '错误信息，请求异常时返回。',
                                'type' => 'string',
                                'example' => '系统错误: openMerchantId 不能为空',
                            ],
                            'Data' => [
                                'description' => '请求接口返回的数据，会员列表',
                                'type' => 'array',
                                'items' => [
                                    'type' => 'object',
                                    'properties' => [
                                        'OpenMerchantId' => [
                                            'description' => '商家加密品牌 ID',
                                            'type' => 'string',
                                            'example' => '750cff00c3e0996d220ac2861dafdfadsf'."\n",
                                        ],
                                        'OuterMemberId' => [
                                            'description' => '商家会员ID',
                                            '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' => '[email protected]',
                                        ],
                                        '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\\": \\"[email protected]\\",\\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"}]',
            'title' => '分页获取会员的信息',
        ],
    ],
    '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',
        ],
    ],
];