magicyclebikeklaviyo/api

Klaviyo API 的 PHP SDK。

维护者

详细信息

github.com/a312354805/jjw-klaviyo-api-php-main

主页

源代码

问题

安装: 1

依赖项: 0

建议者: 0

安全性: 0

星标: 0

关注者: 1

分支: 0

开放问题: 0

dev-main 2022-11-23 12:24 UTC

Requires

  • php: ^7.4 || ^8.0

MIT 447b0b483805ec62757bbce23fc20c066b0b7bbb

phprestapisdkopenapiopenapitoolsopenapi-generator

This package is auto-updated.

Last update: 2024-09-23 16:36:53 UTC

README

  • SDK 版本：1.0.1
  • API 修订版：2022-10-17

有用的资源

设计与方法

此 SDK 是围绕我们的 API 的一个薄层包装。有关行为的全文档，请参阅我们的 API 参考。

此 SDK 与上述语言无关的资源组织方式和命名约定相同，但进行了少数命名空间更改，以符合 PHP 习惯（详细信息见附录）。

组织

此 SDK 组织成以下资源

  • 目录

  • 客户端

  • 事件

  • 流程

  • 列表

  • 指标

  • 配置文件

  • 分段

  • 模板

安装

您可以使用我们的 Packagist 软件包安装此软件包

composer require klaviyo/api

使用示例

<?php
require_once(__DIR__ . '/vendor/autoload.php');

use KlaviyoAPI\KlaviyoAPI;

$klaviyo = new KlaviyoAPI(
    'YOUR_API_KEY', 
    $num_retries = 3, 
    $wait_seconds = 3);

$response = $klaviyo->Metrics->getMetrics();

重试行为

  • SDK 在可解析的错误上重试，即：速率限制（常见）和 Klaviyo 端的服务器错误（罕见）。
  • 上面示例中的关键字参数定义了重试行为
    • wait_seconds 表示每次重试的等待时间，单位为 秒
    • 如果您想禁用重试，请设置 $num_retries = 0
    • 示例中填充了默认值
  • 不可解析的错误以及超时的可解析错误会抛出以下详细的 ApiException。

错误处理

当服务器返回不可解析的响应或可解析的非 2XX 响应超时时，此 SDK 会抛出 ApiException 错误。

如果您想扩展 SDK 本地支持的错误处理，可以使用以下方法从 ApiException 对象检索相应的属性

  • getCode() : int
  • getMessage() : str
  • getReponseBody() : bytes
  • getResponseHeaders() : string[]

例如

try { 
  $klaviyo.Metrics.getMetrics();
} catch (Exception $e) {
  if ($e->getCode() == SOME_INTEGER) {
    doSomething();
  }
}

重要提示

  • 此 SDK 与以下端点链接的语言无关的 API 文档之间的主要区别是，此 SDK 自动添加了与 SDK 版本对应的 revision 标头。
  • 组织：资源组和函数按字母顺序列出，首先是资源名称，然后是 OpenAPI 摘要。操作摘要列在 API 参考 的右侧边栏中。这些摘要直接链接到 API 参考的相关部分。
  • 例如值/数据类型以及参数是否为必需的/可选的，请参阅相应的 API 参考链接。
  • 某些关键字参数对于 API 调用成功是必需的，上述 API 文档是有关哪些关键字参数是必需的的确切来源。
  • 应将 JSON 负载作为关联数组传递
  • PHP 的一个奇怪之处在于，默认/可选参数必须按顺序传递，并且必须包含并设置为 null，至少直到您想要使用的最后一个默认值。
    • 例如，如果某个函数具有以下可选参数 someFunction($a=1, $b=2, $c=3)，并且您只想设置 $b，则必须传递 someFunction($a=null, $b=$YOUR_VALUE)
    • 否则，如果您传递类似 someFunction($b=$YOUR_VALUE) 的内容，PHP 实际上会将 $YOUR_VALUE 分配给参数 $a，这是不正确的。
  • $api_key是可选的，因为它在客户端级别设置。但是，您可以通过将$api_key作为最后一个可选参数传递来覆盖客户端密钥。注意：请勿在客户端/网站上使用私有API密钥。
  • 分页：如果适用，$page_cursor可以作为一个解析后的字符串传递，也可以作为分页API端点返回的整个self.link响应传递。

操作与参数的完整列表

目录

创建目录类别

## Positional Arguments

# $body | associative array

$klaviyo->Catalogs->createCatalogCategory($body);

创建目录类别关系

## Positional Arguments

# $id | string
# $related_resource | string
# $body | associative array

$klaviyo->Catalogs->createCatalogCategoryRelationships($id, $related_resource, $body);

创建目录项目

## Positional Arguments

# $body | associative array

$klaviyo->Catalogs->createCatalogItem($body);

创建目录项目关系

## Positional Arguments

# $id | string
# $related_resource | string
# $body | associative array

$klaviyo->Catalogs->createCatalogItemRelationships($id, $related_resource, $body);

创建目录变体

## Positional Arguments

# $body | associative array

$klaviyo->Catalogs->createCatalogVariant($body);

删除目录类别

## Positional Arguments

# $id | string

$klaviyo->Catalogs->deleteCatalogCategory($id);

删除目录类别关系

## Positional Arguments

# $id | string
# $related_resource | string
# $body | associative array

$klaviyo->Catalogs->deleteCatalogCategoryRelationships($id, $related_resource, $body);

删除目录项目

## Positional Arguments

# $id | string

$klaviyo->Catalogs->deleteCatalogItem($id);

删除目录项目关系

## Positional Arguments

# $id | string
# $related_resource | string
# $body | associative array

$klaviyo->Catalogs->deleteCatalogItemRelationships($id, $related_resource, $body);

删除目录变体

## Positional Arguments

# $id | string

$klaviyo->Catalogs->deleteCatalogVariant($id);

获取目录类别

## Keyword Arguments

# $fields_catalog_category | string[]
# $filter | string
# $page_cursor | string
# $sort | string

$klaviyo->Catalogs->getCatalogCategories($fields_catalog_category=$fields_catalog_category, $filter=$filter, $page_cursor=$page_cursor, $sort=$sort);

获取目录类别

## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_catalog_category | string[]

$klaviyo->Catalogs->getCatalogCategory($id, $fields_catalog_category=$fields_catalog_category);

获取目录类别项目

## Positional Arguments

# $category_id | string

## Keyword Arguments

# $fields_catalog_item | string[]
# $fields_catalog_variant | string[]
# $filter | string
# $include | string[]
# $page_cursor | string
# $sort | string

$klaviyo->Catalogs->getCatalogCategoryItems($category_id, $fields_catalog_item=$fields_catalog_item, $fields_catalog_variant=$fields_catalog_variant, $filter=$filter, $include=$include, $page_cursor=$page_cursor, $sort=$sort);

获取目录类别关系

## Positional Arguments

# $id | string
# $related_resource | string

## Keyword Arguments

# $page_cursor | string

$klaviyo->Catalogs->getCatalogCategoryRelationships($id, $related_resource, $page_cursor=$page_cursor);

获取目录项目

## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_catalog_item | string[]
# $fields_catalog_variant | string[]
# $include | string[]

$klaviyo->Catalogs->getCatalogItem($id, $fields_catalog_item=$fields_catalog_item, $fields_catalog_variant=$fields_catalog_variant, $include=$include);

获取目录项目类别

## Positional Arguments

# $item_id | string

## Keyword Arguments

# $fields_catalog_category | string[]
# $filter | string
# $page_cursor | string
# $sort | string

$klaviyo->Catalogs->getCatalogItemCategories($item_id, $fields_catalog_category=$fields_catalog_category, $filter=$filter, $page_cursor=$page_cursor, $sort=$sort);

获取目录项目关系

## Positional Arguments

# $id | string
# $related_resource | string

## Keyword Arguments

# $page_cursor | string

$klaviyo->Catalogs->getCatalogItemRelationships($id, $related_resource, $page_cursor=$page_cursor);

获取目录项目变体

## Positional Arguments

# $item_id | string

## Keyword Arguments

# $fields_catalog_variant | string[]
# $filter | string
# $page_cursor | string
# $sort | string

$klaviyo->Catalogs->getCatalogItemVariants($item_id, $fields_catalog_variant=$fields_catalog_variant, $filter=$filter, $page_cursor=$page_cursor, $sort=$sort);

获取目录项目

## Keyword Arguments

# $fields_catalog_item | string[]
# $fields_catalog_variant | string[]
# $filter | string
# $include | string[]
# $page_cursor | string
# $sort | string

$klaviyo->Catalogs->getCatalogItems($fields_catalog_item=$fields_catalog_item, $fields_catalog_variant=$fields_catalog_variant, $filter=$filter, $include=$include, $page_cursor=$page_cursor, $sort=$sort);

获取目录变体

## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_catalog_variant | string[]

$klaviyo->Catalogs->getCatalogVariant($id, $fields_catalog_variant=$fields_catalog_variant);

获取目录变体

## Keyword Arguments

# $fields_catalog_variant | string[]
# $filter | string
# $page_cursor | string
# $sort | string

$klaviyo->Catalogs->getCatalogVariants($fields_catalog_variant=$fields_catalog_variant, $filter=$filter, $page_cursor=$page_cursor, $sort=$sort);

获取创建类别作业

## Positional Arguments

# $job_id | string

## Keyword Arguments

# $fields_catalog_category_bulk_create_job | string[]
# $fields_catalog_category | string[]
# $include | string[]

$klaviyo->Catalogs->getCreateCategoriesJob($job_id, $fields_catalog_category_bulk_create_job=$fields_catalog_category_bulk_create_job, $fields_catalog_category=$fields_catalog_category, $include=$include);

获取创建类别作业

## Keyword Arguments

# $fields_catalog_category_bulk_create_job | string[]
# $filter | string
# $page_cursor | string

$klaviyo->Catalogs->getCreateCategoriesJobs($fields_catalog_category_bulk_create_job=$fields_catalog_category_bulk_create_job, $filter=$filter, $page_cursor=$page_cursor);

获取创建项目作业

## Positional Arguments

# $job_id | string

## Keyword Arguments

# $fields_catalog_item_bulk_create_job | string[]
# $fields_catalog_item | string[]
# $include | string[]

$klaviyo->Catalogs->getCreateItemsJob($job_id, $fields_catalog_item_bulk_create_job=$fields_catalog_item_bulk_create_job, $fields_catalog_item=$fields_catalog_item, $include=$include);

获取创建项目作业

## Keyword Arguments

# $fields_catalog_item_bulk_create_job | string[]
# $filter | string
# $page_cursor | string

$klaviyo->Catalogs->getCreateItemsJobs($fields_catalog_item_bulk_create_job=$fields_catalog_item_bulk_create_job, $filter=$filter, $page_cursor=$page_cursor);

获取创建变体作业

## Positional Arguments

# $job_id | string

## Keyword Arguments

# $fields_catalog_variant_bulk_create_job | string[]
# $fields_catalog_variant | string[]
# $include | string[]

$klaviyo->Catalogs->getCreateVariantsJob($job_id, $fields_catalog_variant_bulk_create_job=$fields_catalog_variant_bulk_create_job, $fields_catalog_variant=$fields_catalog_variant, $include=$include);

获取创建变体作业

## Keyword Arguments

# $fields_catalog_variant_bulk_create_job | string[]
# $filter | string
# $page_cursor | string

$klaviyo->Catalogs->getCreateVariantsJobs($fields_catalog_variant_bulk_create_job=$fields_catalog_variant_bulk_create_job, $filter=$filter, $page_cursor=$page_cursor);

获取删除类别作业

## Positional Arguments

# $job_id | string

## Keyword Arguments

# $fields_catalog_category_bulk_delete_job | string[]

$klaviyo->Catalogs->getDeleteCategoriesJob($job_id, $fields_catalog_category_bulk_delete_job=$fields_catalog_category_bulk_delete_job);

获取删除类别作业

## Keyword Arguments

# $fields_catalog_category_bulk_delete_job | string[]
# $filter | string
# $page_cursor | string

$klaviyo->Catalogs->getDeleteCategoriesJobs($fields_catalog_category_bulk_delete_job=$fields_catalog_category_bulk_delete_job, $filter=$filter, $page_cursor=$page_cursor);

获取删除项目作业

## Positional Arguments

# $job_id | string

## Keyword Arguments

# $fields_catalog_item_bulk_delete_job | string[]

$klaviyo->Catalogs->getDeleteItemsJob($job_id, $fields_catalog_item_bulk_delete_job=$fields_catalog_item_bulk_delete_job);

获取删除项目作业

## Keyword Arguments

# $fields_catalog_item_bulk_delete_job | string[]
# $filter | string
# $page_cursor | string

$klaviyo->Catalogs->getDeleteItemsJobs($fields_catalog_item_bulk_delete_job=$fields_catalog_item_bulk_delete_job, $filter=$filter, $page_cursor=$page_cursor);

获取删除变体作业

## Positional Arguments

# $job_id | string

## Keyword Arguments

# $fields_catalog_variant_bulk_delete_job | string[]

$klaviyo->Catalogs->getDeleteVariantsJob($job_id, $fields_catalog_variant_bulk_delete_job=$fields_catalog_variant_bulk_delete_job);

获取删除变体作业

## Keyword Arguments

# $fields_catalog_variant_bulk_delete_job | string[]
# $filter | string
# $page_cursor | string

$klaviyo->Catalogs->getDeleteVariantsJobs($fields_catalog_variant_bulk_delete_job=$fields_catalog_variant_bulk_delete_job, $filter=$filter, $page_cursor=$page_cursor);

获取更新类别作业

## Positional Arguments

# $job_id | string

## Keyword Arguments

# $fields_catalog_category_bulk_update_job | string[]
# $fields_catalog_category | string[]
# $include | string[]

$klaviyo->Catalogs->getUpdateCategoriesJob($job_id, $fields_catalog_category_bulk_update_job=$fields_catalog_category_bulk_update_job, $fields_catalog_category=$fields_catalog_category, $include=$include);

获取更新类别作业

## Keyword Arguments

# $fields_catalog_category_bulk_update_job | string[]
# $filter | string
# $page_cursor | string

$klaviyo->Catalogs->getUpdateCategoriesJobs($fields_catalog_category_bulk_update_job=$fields_catalog_category_bulk_update_job, $filter=$filter, $page_cursor=$page_cursor);

获取更新项目作业

## Positional Arguments

# $job_id | string

## Keyword Arguments

# $fields_catalog_item_bulk_update_job | string[]
# $fields_catalog_item | string[]
# $include | string[]

$klaviyo->Catalogs->getUpdateItemsJob($job_id, $fields_catalog_item_bulk_update_job=$fields_catalog_item_bulk_update_job, $fields_catalog_item=$fields_catalog_item, $include=$include);

获取更新项目作业

## Keyword Arguments

# $fields_catalog_item_bulk_update_job | string[]
# $filter | string
# $page_cursor | string

$klaviyo->Catalogs->getUpdateItemsJobs($fields_catalog_item_bulk_update_job=$fields_catalog_item_bulk_update_job, $filter=$filter, $page_cursor=$page_cursor);

获取更新变体作业

## Positional Arguments

# $job_id | string

## Keyword Arguments

# $fields_catalog_variant_bulk_update_job | string[]
# $fields_catalog_variant | string[]
# $include | string[]

$klaviyo->Catalogs->getUpdateVariantsJob($job_id, $fields_catalog_variant_bulk_update_job=$fields_catalog_variant_bulk_update_job, $fields_catalog_variant=$fields_catalog_variant, $include=$include);

获取更新变体作业

## Keyword Arguments

# $fields_catalog_variant_bulk_update_job | string[]
# $filter | string
# $page_cursor | string

$klaviyo->Catalogs->getUpdateVariantsJobs($fields_catalog_variant_bulk_update_job=$fields_catalog_variant_bulk_update_job, $filter=$filter, $page_cursor=$page_cursor);

触发创建类别作业

## Positional Arguments

# $body | associative array

$klaviyo->Catalogs->spawnCreateCategoriesJob($body);

触发创建项目作业

## Positional Arguments

# $body | associative array

$klaviyo->Catalogs->spawnCreateItemsJob($body);

触发创建变体作业

## Positional Arguments

# $body | associative array

$klaviyo->Catalogs->spawnCreateVariantsJob($body);

触发删除类别作业

## Positional Arguments

# $body | associative array

$klaviyo->Catalogs->spawnDeleteCategoriesJob($body);

触发删除项目作业

## Positional Arguments

# $body | associative array

$klaviyo->Catalogs->spawnDeleteItemsJob($body);

触发删除变体作业

## Positional Arguments

# $body | associative array

$klaviyo->Catalogs->spawnDeleteVariantsJob($body);

触发更新类别作业

## Positional Arguments

# $body | associative array

$klaviyo->Catalogs->spawnUpdateCategoriesJob($body);

触发更新项目作业

## Positional Arguments

# $body | associative array

$klaviyo->Catalogs->spawnUpdateItemsJob($body);

触发更新变体作业

## Positional Arguments

# $body | associative array

$klaviyo->Catalogs->spawnUpdateVariantsJob($body);

更新目录类别

## Positional Arguments

# $id | string
# $body | associative array

$klaviyo->Catalogs->updateCatalogCategory($id, $body);

更新目录类别关系

## Positional Arguments

# $id | string
# $related_resource | string
# $body | associative array

$klaviyo->Catalogs->updateCatalogCategoryRelationships($id, $related_resource, $body);

更新目录项目

## Positional Arguments

# $id | string
# $body | associative array

$klaviyo->Catalogs->updateCatalogItem($id, $body);

更新目录项目关系

## Positional Arguments

# $id | string
# $related_resource | string
# $body | associative array

$klaviyo->Catalogs->updateCatalogItemRelationships($id, $related_resource, $body);

更新目录变体

## Positional Arguments

# $id | string
# $body | associative array

$klaviyo->Catalogs->updateCatalogVariant($id, $body);

客户端

创建客户端事件

## Positional Arguments

# $company_id | string
# $body | associative array

$klaviyo->Client->createClientEvent($company_id, $body);

创建客户端配置文件

## Positional Arguments

# $company_id | string
# $body | associative array

$klaviyo->Client->createClientProfile($company_id, $body);

创建客户端订阅

## Positional Arguments

# $company_id | string
# $body | associative array

$klaviyo->Client->createClientSubscription($company_id, $body);

事件

创建事件

## Positional Arguments

# $body | associative array

$klaviyo->Events->createEvent($body);

获取事件

## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_event | string[]
# $fields_metric | string[]
# $fields_profile | string[]
# $include | string[]

$klaviyo->Events->getEvent($id, $fields_event=$fields_event, $fields_metric=$fields_metric, $fields_profile=$fields_profile, $include=$include);

获取事件度量

## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_metric | string[]

$klaviyo->Events->getEventMetrics($id, $fields_metric=$fields_metric);

获取事件配置文件

## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_profile | string[]

$klaviyo->Events->getEventProfiles($id, $fields_profile=$fields_profile);

获取事件关系

## Positional Arguments

# $id | string
# $related_resource | string

$klaviyo->Events->getEventRelationships($id, $related_resource);

获取事件

## Keyword Arguments

# $fields_event | string[]
# $fields_metric | string[]
# $fields_profile | string[]
# $filter | string
# $include | string[]
# $page_cursor | string
# $sort | string

$klaviyo->Events->getEvents($fields_event=$fields_event, $fields_metric=$fields_metric, $fields_profile=$fields_profile, $filter=$filter, $include=$include, $page_cursor=$page_cursor, $sort=$sort);

流程

获取流程

## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_flow_action | string[]
# $fields_flow | string[]
# $include | string[]

$klaviyo->Flows->getFlow($id, $fields_flow_action=$fields_flow_action, $fields_flow=$fields_flow, $include=$include);

获取流程操作

## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_flow_action | string[]
# $fields_flow_message | string[]
# $fields_flow | string[]
# $include | string[]

$klaviyo->Flows->getFlowAction($id, $fields_flow_action=$fields_flow_action, $fields_flow_message=$fields_flow_message, $fields_flow=$fields_flow, $include=$include);

获取为流程操作获取流程

## Positional Arguments

# $action_id | string

## Keyword Arguments

# $fields_flow | string[]

$klaviyo->Flows->getFlowActionFlow($action_id, $fields_flow=$fields_flow);

获取为流程操作获取消息

## Positional Arguments

# $action_id | string

## Keyword Arguments

# $fields_flow_message | string[]
# $filter | string
# $sort | string

$klaviyo->Flows->getFlowActionMessages($action_id, $fields_flow_message=$fields_flow_message, $filter=$filter, $sort=$sort);

获取流程操作关系

## Positional Arguments

# $id | string
# $related_resource | string

## Keyword Arguments

# $filter | string
# $sort | string

$klaviyo->Flows->getFlowActionRelationships($id, $related_resource, $filter=$filter, $sort=$sort);

获取为流程获取流程操作

## Positional Arguments

# $flow_id | string

## Keyword Arguments

# $fields_flow_action | string[]
# $filter | string
# $sort | string

$klaviyo->Flows->getFlowFlowActions($flow_id, $fields_flow_action=$fields_flow_action, $filter=$filter, $sort=$sort);

获取流程消息

## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_flow_action | string[]
# $fields_flow_message | string[]
# $include | string[]

$klaviyo->Flows->getFlowMessage($id, $fields_flow_action=$fields_flow_action, $fields_flow_message=$fields_flow_message, $include=$include);

获取为消息获取流程操作

## Positional Arguments

# $message_id | string

## Keyword Arguments

# $fields_flow_action | string[]

$klaviyo->Flows->getFlowMessageAction($message_id, $fields_flow_action=$fields_flow_action);

获取流程消息关系

## Positional Arguments

# $id | string
# $related_resource | string

$klaviyo->Flows->getFlowMessageRelationships($id, $related_resource);

获取流程关系

## Positional Arguments

# $id | string
# $related_resource | string

## Keyword Arguments

# $filter | string
# $sort | string

$klaviyo->Flows->getFlowRelationships($id, $related_resource, $filter=$filter, $sort=$sort);

获取流程

## Keyword Arguments

# $fields_flow_action | string[]
# $fields_flow | string[]
# $filter | string
# $include | string[]
# $sort | string

$klaviyo->Flows->getFlows($fields_flow_action=$fields_flow_action, $fields_flow=$fields_flow, $filter=$filter, $include=$include, $sort=$sort);

更新流程状态

## Positional Arguments

# $id | string
# $body | associative array

$klaviyo->Flows->updateFlow($id, $body);

列表

创建列表

## Positional Arguments

# $body | associative array

$klaviyo->Lists->createList($body);

将配置文件添加到列表

## Positional Arguments

# $id | string
# $related_resource | string
# $body | associative array

$klaviyo->Lists->createListRelationships($id, $related_resource, $body);

删除列表

## Positional Arguments

# $id | string

$klaviyo->Lists->deleteList($id);

从列表中删除配置文件

## Positional Arguments

# $id | string
# $related_resource | string
# $body | associative array

$klaviyo->Lists->deleteListRelationships($id, $related_resource, $body);

获取列表

## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_list | string[]

$klaviyo->Lists->getList($id, $fields_list=$fields_list);

获取列表配置文件

## Positional Arguments

# $list_id | string

## Keyword Arguments

# $fields_profile | string[]
# $filter | string
# $page_cursor | string

$klaviyo->Lists->getListProfiles($list_id, $fields_profile=$fields_profile, $filter=$filter, $page_cursor=$page_cursor);

获取列表配置文件关系

## Positional Arguments

# $id | string
# $related_resource | string

## Keyword Arguments

# $page_cursor | string

$klaviyo->Lists->getListRelationships($id, $related_resource, $page_cursor=$page_cursor);

获取列表

## Keyword Arguments

# $fields_list | string[]
# $filter | string
# $page_cursor | string

$klaviyo->Lists->getLists($fields_list=$fields_list, $filter=$filter, $page_cursor=$page_cursor);

更新列表

## Positional Arguments

# $id | string
# $body | associative array

$klaviyo->Lists->updateList($id, $body);

指标

获取度量

## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_metric | string[]

$klaviyo->Metrics->getMetric($id, $fields_metric=$fields_metric);

获取度量

## Keyword Arguments

# $fields_metric | string[]
# $filter | string
# $page_cursor | string

$klaviyo->Metrics->getMetrics($fields_metric=$fields_metric, $filter=$filter, $page_cursor=$page_cursor);

查询度量聚合

## Positional Arguments

# $body | associative array

$klaviyo->Metrics->queryMetricAggregates($body);

配置文件

创建配置文件

## Positional Arguments

# $body | associative array

$klaviyo->Profiles->createProfile($body);

获取配置文件

## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_list | string[]
# $fields_profile | string[]
# $fields_segment | string[]
# $include | string[]

$klaviyo->Profiles->getProfile($id, $fields_list=$fields_list, $fields_profile=$fields_profile, $fields_segment=$fields_segment, $include=$include);

获取配置文件列表

## Positional Arguments

# $profile_id | string

## Keyword Arguments

# $fields_list | string[]

$klaviyo->Profiles->getProfileLists($profile_id, $fields_list=$fields_list);

获取配置文件关系

## Positional Arguments

# $id | string
# $related_resource | string

$klaviyo->Profiles->getProfileRelationships($id, $related_resource);

获取配置文件段

## Positional Arguments

# $profile_id | string

## Keyword Arguments

# $fields_segment | string[]

$klaviyo->Profiles->getProfileSegments($profile_id, $fields_segment=$fields_segment);

获取配置文件

## Keyword Arguments

# $fields_profile | string[]
# $filter | string
# $page_cursor | string
# $sort | string

$klaviyo->Profiles->getProfiles($fields_profile=$fields_profile, $filter=$filter, $page_cursor=$page_cursor, $sort=$sort);

订阅配置文件

## Positional Arguments

# $body | associative array

$klaviyo->Profiles->subscribeProfiles($body);

抑制配置文件

## Positional Arguments

# $body | associative array

$klaviyo->Profiles->suppressProfiles($body);

取消订阅配置文件

## Positional Arguments

# $body | associative array

$klaviyo->Profiles->unsubscribeProfiles($body);

取消抑制配置文件

## Positional Arguments

# $body | associative array

$klaviyo->Profiles->unsuppressProfiles($body);

更新配置文件

## Positional Arguments

# $id | string
# $body | associative array

$klaviyo->Profiles->updateProfile($id, $body);

分段

获取段

## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_segment | string[]

$klaviyo->Segments->getSegment($id, $fields_segment=$fields_segment);

获取段配置文件

## Positional Arguments

# $segment_id | string

## Keyword Arguments

# $fields_profile | string[]
# $filter | string
# $page_cursor | string

$klaviyo->Segments->getSegmentProfiles($segment_id, $fields_profile=$fields_profile, $filter=$filter, $page_cursor=$page_cursor);

获取段关系

## Positional Arguments

# $id | string
# $related_resource | string

## Keyword Arguments

# $page_cursor | string

$klaviyo->Segments->getSegmentRelationships($id, $related_resource, $page_cursor=$page_cursor);

获取段

## Keyword Arguments

# $fields_segment | string[]
# $filter | string
# $page_cursor | string

$klaviyo->Segments->getSegments($fields_segment=$fields_segment, $filter=$filter, $page_cursor=$page_cursor);

更新段

## Positional Arguments

# $id | string
# $body | associative array

$klaviyo->Segments->updateSegment($id, $body);

模板

创建模板

## Positional Arguments

# $body | associative array

$klaviyo->Templates->createTemplate($body);

创建模板克隆

## Positional Arguments

# $id | string
# $body | associative array

$klaviyo->Templates->createTemplateClone($id, $body);

创建模板渲染

## Positional Arguments

# $id | string
# $body | associative array

$klaviyo->Templates->createTemplateRender($id, $body);

删除模板

## Positional Arguments

# $id | string

$klaviyo->Templates->deleteTemplate($id);

获取模板

## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_template | string[]

$klaviyo->Templates->getTemplate($id, $fields_template=$fields_template);

获取模板

## Keyword Arguments

# $fields_template | string[]
# $filter | string
# $page_cursor | string
# $sort | string

$klaviyo->Templates->getTemplates($fields_template=$fields_template, $filter=$filter, $page_cursor=$page_cursor, $sort=$sort);

更新模板

## Positional Arguments

# $id | string
# $body | associative array

$klaviyo->Templates->updateTemplate($id, $body);

附录

全局关键字参数

说明

  • 这些是可以应用于任何端点调用，并且对SDK唯一的参数。
  • 它们位于最后，在上述所有端点特定关键字参数之后，顺序与以下列表相同。
  • 它们与任何其他PHP关键字参数一样，存在相同的怪癖，即在包含它们之前，需要先包含所有在它们之前列出的关键字参数。这包括给定端点的所有端点特定关键字参数，以及任何适用的前面列出的全局关键字参数。即使其他关键字参数没有被使用，这也适用；在这种情况下，将这些参数设置为null，但再次强调，它们必须被包含。

我们目前支持以下全局关键字参数

  • $apiKey：使用此参数来覆盖客户端级别的api_key，您在客户端实例化时定义此api_key。

命名空间

为了使SDK符合PHP惯用用法，我们对以下命名空间进行了以下更改（相对于上面无语言限制的资源，例如API文档、指南等）。

  • 从函数名（操作ID）中删除下划线
  • 函数名使用camelCase（例如getMetrics）
  • 资源名使用PascalCase（例如Metrics）
  • 参数名保持不变

参数 & 参数

我们遵循以下约定进行参数/参数传递

  1. 所有参数都作为函数参数传递。
  2. 所有可选参数，以及所有Body和Form Data参数（包括必需的），都作为关键字参数传递。
  3. 所有在文档中标记为required的查询和路径参数都作为位置参数传递。
  4. $api_key是可选的，因为它在客户端级别设置。然而，您可以通过将$api_key作为最后一个可选参数传递来覆盖客户端密钥。提醒：不要在客户端这么做。