README

SDK 版本：10.0.0
API 修订版：2024-07-15

有帮助的资源

设计 & 方法

此 SDK 是我们 API 的薄包装。有关行为的完整文档，请参阅我们的 API 参考。

此 SDK 反映了上述与语言无关的资源组织和命名约定，并对命名空间进行了一些更改，以符合 PHP 习惯（详细信息见附录）。

组织

此 SDK 组织如下资源

账户
活动
目录
优惠券
数据隐私
事件
流程
表单
图像
列表
度量
配置文件
报告
段
标签
模板
Webhooks

安装

您可以使用我们的 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,
    $guzzle_options = [],
    $user_agent_suffix = "/YOUR_APP_NAME");

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

用例示例

如何使用过滤、排序和备用字段集 JSON API 功能

用例：获取与特定度量相关的事件，然后按从旧到新的 datetime 对事件属性进行排序。

$klaviyo->Events->getEvents(
    $fields_event=['event_properties'], 
    $fields_metric=NULL, 
    $fields_profile=NULL, 
    $filter="equals(metric_id,\"UMTLbD\")", 
    $include=NULL, 
    $page_cursor=NULL, 
    $sort='-datetime'
);

注意：filter 参数值需要 URL 编码

如何根据 datetime 进行过滤

用例：获取在两个 datetime 之间更新的配置文件。

$klaviyo->Profiles->getProfiles(
    $additional_fields_profile=NULL, 
    $fields_profile=NULL, 
    $filter='less-than(updated,2023-04-26T00:00:00Z),greater-than(updated,2023-04-19T00:00:00Z)', 
);

如何使用分页和 page[size] 参数

用例：使用基于游标的分页获取下一个 20 个配置文件记录。

$klaviyo->Profiles->getProfiles(
    $additional_fields_profile=NULL, 
    $fields_profile=NULL, 
    $filter=NULL,
    $page_cursor="https://a.klaviyo.com/api/profiles/?page%5Bcursor%5D=bmV4dDo6aWQ6OjAxRjNaWk5ITlRYMUtFVEhQMzJTUzRBN0ZY", 
    $page_size=20, 
);

注意：此页面游标值正好是响应中的 self/next/prev 返回的值

如何通过 additional-fields 和 includes 参数向 API 响应添加更多信息

用例：获取特定配置文件，返回额外的预测分析字段，并返回与配置文件关联的列表对象。

$klaviyo->Profiles->getProfile(
    '01F3ZZNHPY4YZFVGNBH5THCNXE', 
    $additional_fields_profile=['predictive_analytics'], 
    $fields_list=NULL, 
    $fields_profile=NULL, 
    $fields_segment=NULL, 
    $include=['lists']
);

如何使用我们的关系端点查看相关资源

用例：获取具有给定 profile_id 的配置文件的所有列表成员资格。

$klaviyo->Profiles->getProfileRelationshipsLists('01GDDKASAP8TKDDA2GRZDSVP4H');

如何查看与特定标签关联的 Klaviyo 对象

用例：获取与给定 tag_id 关联的所有活动。

$klaviyo->Tags->getTagRelationshipsCampaigns('f4bc6670-1aa5-47df-827a-d30a7e543088');

从文件上传图像

当使用 Images.uploadImageFromFile(file, name=name) 时，`file` 可以是文件路径字符串或 bytearray。

注意：当文件是 bytearray 时，您需要使用可选的 name 参数来指定文件名，否则名称将默认为 unnamed_image_from_python_sdk

作为文件路径

filepath = '/path/to/image.png'
klaviyo.Images.upload_image_from_file(file, name=name)

作为 bytearray

filepath = '/path/to/image.png'
with open(filepath, 'rb') as f:
    file = f.read()
klaviyo.Images.upload_image_from_file(file, name=name)

重试行为

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

错误处理

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

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

getCode() : int
getMessage() : str
getResponseBody() : 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

# $id | string

## Keyword Arguments

# $fields_account | string[]

$klaviyo->Accounts->getAccount($id, $fields_account=$fields_account);

获取账户列表

## Keyword Arguments

# $fields_account | string[]

$klaviyo->Accounts->getAccounts($fields_account=$fields_account);

活动

创建活动

## Positional Arguments

# $body | associative array

$klaviyo->Campaigns->createCampaign($body);

创建活动克隆

## Positional Arguments

# $body | associative array

$klaviyo->Campaigns->createCampaignClone($body);

分配活动消息模板

## Positional Arguments

# $body | associative array

$klaviyo->Campaigns->createCampaignMessageAssignTemplate($body);

创建活动接收者估算作业

## Positional Arguments

# $body | associative array

$klaviyo->Campaigns->createCampaignRecipientEstimationJob($body);

创建活动发送作业

## Positional Arguments

# $body | associative array

$klaviyo->Campaigns->createCampaignSendJob($body);

删除活动

## Positional Arguments

# $id | string

$klaviyo->Campaigns->deleteCampaign($id);

获取活动

## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_campaign_message | string[]
# $fields_campaign | string[]
# $fields_tag | string[]
# $include | string[]

$klaviyo->Campaigns->getCampaign($id, $fields_campaign_message=$fields_campaign_message, $fields_campaign=$fields_campaign, $fields_tag=$fields_tag, $include=$include);

获取活动活动消息

## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_campaign_message | string[]
# $fields_campaign | string[]
# $fields_template | string[]
# $include | string[]

$klaviyo->Campaigns->getCampaignCampaignMessages($id, $fields_campaign_message=$fields_campaign_message, $fields_campaign=$fields_campaign, $fields_template=$fields_template, $include=$include);

获取活动消息

## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_campaign_message | string[]
# $fields_campaign | string[]
# $fields_template | string[]
# $include | string[]

$klaviyo->Campaigns->getCampaignMessage($id, $fields_campaign_message=$fields_campaign_message, $fields_campaign=$fields_campaign, $fields_template=$fields_template, $include=$include);

获取活动消息活动

## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_campaign | string[]

$klaviyo->Campaigns->getCampaignMessageCampaign($id, $fields_campaign=$fields_campaign);

获取活动消息关系活动

## Positional Arguments

# $id | string

$klaviyo->Campaigns->getCampaignMessageRelationshipsCampaign($id);

获取活动消息关系模板

## Positional Arguments

# $id | string

$klaviyo->Campaigns->getCampaignMessageRelationshipsTemplate($id);

获取活动消息模板

## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_template | string[]

$klaviyo->Campaigns->getCampaignMessageTemplate($id, $fields_template=$fields_template);

获取活动接收者估算

## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_campaign_recipient_estimation | string[]

$klaviyo->Campaigns->getCampaignRecipientEstimation($id, $fields_campaign_recipient_estimation=$fields_campaign_recipient_estimation);

获取活动接收者估算作业

## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_campaign_recipient_estimation_job | string[]

$klaviyo->Campaigns->getCampaignRecipientEstimationJob($id, $fields_campaign_recipient_estimation_job=$fields_campaign_recipient_estimation_job);

获取活动关系活动消息

## Positional Arguments

# $id | string

$klaviyo->Campaigns->getCampaignRelationshipsCampaignMessages($id);

获取活动关系标签

## Positional Arguments

# $id | string

$klaviyo->Campaigns->getCampaignRelationshipsTags($id);

获取活动发送作业

## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_campaign_send_job | string[]

$klaviyo->Campaigns->getCampaignSendJob($id, $fields_campaign_send_job=$fields_campaign_send_job);

获取活动标签

## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_tag | string[]

$klaviyo->Campaigns->getCampaignTags($id, $fields_tag=$fields_tag);

获取活动列表

## Positional Arguments

# $filter | string

## Keyword Arguments

# $fields_campaign_message | string[]
# $fields_campaign | string[]
# $fields_tag | string[]
# $include | string[]
# $page_cursor | string
# $sort | string

$klaviyo->Campaigns->getCampaigns($filter, $fields_campaign_message=$fields_campaign_message, $fields_campaign=$fields_campaign, $fields_tag=$fields_tag, $include=$include, $page_cursor=$page_cursor, $sort=$sort);

更新活动

## Positional Arguments

# $id | string
# $body | associative array

$klaviyo->Campaigns->updateCampaign($id, $body);

更新活动消息

## Positional Arguments

# $id | string
# $body | associative array

$klaviyo->Campaigns->updateCampaignMessage($id, $body);

更新活动发送作业

## Positional Arguments

# $id | string
# $body | associative array

$klaviyo->Campaigns->updateCampaignSendJob($id, $body);

## Positional Arguments

# $id | string

## Keyword Arguments

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

$klaviyo->Catalogs->getCatalogCategoryItems($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

## Keyword Arguments

# $page_cursor | string

$klaviyo->Catalogs->getCatalogCategoryRelationshipsItems($id, $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

# $id | string

## Keyword Arguments

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

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

获取目录项目关系类别

## Positional Arguments

# $id | string

## Keyword Arguments

# $page_cursor | string

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

获取目录项目变体

## Positional Arguments

# $id | string

## Keyword Arguments

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

$klaviyo->Catalogs->getCatalogItemVariants($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);

方法别名

$klaviyo->Catalogs->getCatalogCategoryBulkCreateJob($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);

方法别名

$klaviyo->Catalogs->getCatalogCategoryBulkCreateJobs($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);

方法别名

$klaviyo->Catalogs->getCatalogItemBulkCreateJob($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);

方法别名

$klaviyo->Catalogs->getCatalogItemBulkCreateJobs($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);

方法别名

$klaviyo->Catalogs->getCatalogVariantBulkCreateJob($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);

方法别名

$klaviyo->Catalogs->getCatalogVariantBulkCreateJobs($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);

方法别名

$klaviyo->Catalogs->getCatalogCategoryBulkDeleteJob($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);

方法别名

$klaviyo->Catalogs->getCatalogCategoryBulkDeleteJobs($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);

方法别名

$klaviyo->Catalogs->getCatalogItemBulkDeleteJob($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);

方法别名

$klaviyo->Catalogs->getCatalogItemBulkDeleteJobs($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);

方法别名

$klaviyo->Catalogs->getCatalogVariantBulkDeleteJob($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);

方法别名

$klaviyo->Catalogs->getCatalogVariantBulkDeleteJobs($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);

方法别名

$klaviyo->Catalogs->getCatalogCategoryBulkUpdateJob($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);

方法别名

$klaviyo->Catalogs->getCatalogCategoryBulkUpdateJobs($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);

方法别名

$klaviyo->Catalogs->getCatalogItemBulkUpdateJob($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);

方法别名

$klaviyo->Catalogs->getCatalogItemBulkUpdateJobs($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);

方法别名

$klaviyo->Catalogs->getCatalogVariantBulkUpdateJob($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);

方法别名

$klaviyo->Catalogs->getCatalogVariantBulkUpdateJobs($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);

方法别名

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

创建创建项目作业

## Positional Arguments

# $body | associative array

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

方法别名

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

创建创建变体作业

## Positional Arguments

# $body | associative array

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

方法别名

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

创建删除类别作业

## Positional Arguments

# $body | associative array

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

方法别名

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

创建删除项目作业

## Positional Arguments

# $body | associative array

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

方法别名

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

创建删除变体作业

## Positional Arguments

# $body | associative array

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

方法别名

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

创建更新类别作业

## Positional Arguments

# $body | associative array

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

方法别名

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

创建更新项目作业

## Positional Arguments

# $body | associative array

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

方法别名

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

创建更新变体作业

## Positional Arguments

# $body | associative array

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

方法别名

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

更新目录类别

## Positional Arguments

# $id | string
# $body | associative array

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

更新目录类别关系项目

## Positional Arguments

# $id | string
# $body | associative array

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

更新目录项目

## Positional Arguments

# $id | string
# $body | associative array

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

更新目录项目关系类别

## Positional Arguments

# $id | string
# $body | associative array

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

更新目录变体

## Positional Arguments

# $id | string
# $body | associative array

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

优惠券

创建优惠券

## Positional Arguments

# $body | associative array

$klaviyo->Coupons->createCoupon($body);

创建优惠券代码

## Positional Arguments

# $body | associative array

$klaviyo->Coupons->createCouponCode($body);

删除优惠券

## Positional Arguments

# $id | string

$klaviyo->Coupons->deleteCoupon($id);

删除优惠券代码

## Positional Arguments

# $id | string

$klaviyo->Coupons->deleteCouponCode($id);

获取优惠券

## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_coupon | string[]

$klaviyo->Coupons->getCoupon($id, $fields_coupon=$fields_coupon);

获取优惠券代码

## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_coupon_code | string[]
# $fields_coupon | string[]
# $include | string[]

$klaviyo->Coupons->getCouponCode($id, $fields_coupon_code=$fields_coupon_code, $fields_coupon=$fields_coupon, $include=$include);

获取优惠券代码批量创建作业

## Positional Arguments

# $job_id | string

## Keyword Arguments

# $fields_coupon_code_bulk_create_job | string[]
# $fields_coupon_code | string[]
# $include | string[]

$klaviyo->Coupons->getCouponCodeBulkCreateJob($job_id, $fields_coupon_code_bulk_create_job=$fields_coupon_code_bulk_create_job, $fields_coupon_code=$fields_coupon_code, $include=$include);

获取优惠券代码批量创建作业

## Keyword Arguments

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

$klaviyo->Coupons->getCouponCodeBulkCreateJobs($fields_coupon_code_bulk_create_job=$fields_coupon_code_bulk_create_job, $filter=$filter, $page_cursor=$page_cursor);

获取优惠券代码与优惠券的关系

## Positional Arguments

# $id | string

## Keyword Arguments

# $page_cursor | string

$klaviyo->Coupons->getCouponCodeRelationshipsCoupon($id, $page_cursor=$page_cursor);

获取优惠券代码

## Keyword Arguments

# $fields_coupon_code | string[]
# $fields_coupon | string[]
# $filter | string
# $include | string[]
# $page_cursor | string

$klaviyo->Coupons->getCouponCodes($fields_coupon_code=$fields_coupon_code, $fields_coupon=$fields_coupon, $filter=$filter, $include=$include, $page_cursor=$page_cursor);

获取优惠券的优惠券代码

## Positional Arguments

# $id | string

## Keyword Arguments

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

$klaviyo->Coupons->getCouponCodesForCoupon($id, $fields_coupon_code=$fields_coupon_code, $filter=$filter, $page_cursor=$page_cursor);

方法别名

$klaviyo->Coupons->getCouponCouponCodes($id, $fields_coupon_code=$fields_coupon_code, $filter=$filter, $page_cursor=$page_cursor);

获取优惠券代码的优惠券

## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_coupon | string[]

$klaviyo->Coupons->getCouponForCouponCode($id, $fields_coupon=$fields_coupon);

方法别名

$klaviyo->Coupons->getCouponCodeCoupon($id, $fields_coupon=$fields_coupon);

获取优惠券与优惠券代码的关系

## Positional Arguments

# $id | string

$klaviyo->Coupons->getCouponRelationshipsCouponCodes($id);

获取优惠券

## Keyword Arguments

# $fields_coupon | string[]
# $page_cursor | string

$klaviyo->Coupons->getCoupons($fields_coupon=$fields_coupon, $page_cursor=$page_cursor);

创建优惠券代码批量创建作业

## Positional Arguments

# $body | associative array

$klaviyo->Coupons->spawnCouponCodeBulkCreateJob($body);

方法别名

$klaviyo->Coupons->createCouponCodeBulkCreateJob($body);

更新优惠券

## Positional Arguments

# $id | string
# $body | associative array

$klaviyo->Coupons->updateCoupon($id, $body);

更新优惠券代码

## Positional Arguments

# $id | string
# $body | associative array

$klaviyo->Coupons->updateCouponCode($id, $body);

数据隐私

请求删除配置文件

## Positional Arguments

# $body | associative array

$klaviyo->DataPrivacy->requestProfileDeletion($body);

方法别名

$klaviyo->DataPrivacy->createDataPrivacyDeletionJob($body);

事件

批量创建事件

## Positional Arguments

# $body | associative array

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

方法别名

$klaviyo->Events->createEventBulkCreateJob($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->getEventMetric($id, $fields_metric=$fields_metric);

获取事件配置文件

## Positional Arguments

# $id | string

## Keyword Arguments

# $additional_fields_profile | string[]
# $fields_profile | string[]

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

获取事件与度量关系

## Positional Arguments

# $id | string

$klaviyo->Events->getEventRelationshipsMetric($id);

获取事件与配置文件关系

## Positional Arguments

# $id | string

$klaviyo->Events->getEventRelationshipsProfile($id);

获取事件

## 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

$klaviyo->Flows->deleteFlow($id);

获取流程

## Positional Arguments

# $id | string

## Keyword Arguments

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

$klaviyo->Flows->getFlow($id, $fields_flow_action=$fields_flow_action, $fields_flow=$fields_flow, $fields_tag=$fields_tag, $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

# $id | string

## Keyword Arguments

# $fields_flow | string[]

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

获取流程动作消息

## Positional Arguments

# $id | string

## Keyword Arguments

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

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

获取流程动作与流程关系

## Positional Arguments

# $id | string

$klaviyo->Flows->getFlowActionRelationshipsFlow($id);

获取流程动作与消息关系

## Positional Arguments

# $id | string

## Keyword Arguments

# $filter | string
# $page_cursor | string
# $page_size | int
# $sort | string

$klaviyo->Flows->getFlowActionRelationshipsMessages($id, $filter=$filter, $page_cursor=$page_cursor, $page_size=$page_size, $sort=$sort);

获取流程动作

## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_flow_action | string[]
# $filter | string
# $page_cursor | string
# $page_size | int
# $sort | string

$klaviyo->Flows->getFlowFlowActions($id, $fields_flow_action=$fields_flow_action, $filter=$filter, $page_cursor=$page_cursor, $page_size=$page_size, $sort=$sort);

获取流程消息

## Positional Arguments

# $id | string

## Keyword Arguments

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

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

获取消息对应的流程动作

## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_flow_action | string[]

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

获取消息与动作关系

## Positional Arguments

# $id | string

$klaviyo->Flows->getFlowMessageRelationshipsAction($id);

获取消息与模板关系

## Positional Arguments

# $id | string

$klaviyo->Flows->getFlowMessageRelationshipsTemplate($id);

获取流程消息模板

## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_template | string[]

$klaviyo->Flows->getFlowMessageTemplate($id, $fields_template=$fields_template);

获取流程与动作关系

## Positional Arguments

# $id | string

## Keyword Arguments

# $filter | string
# $page_size | int
# $sort | string

$klaviyo->Flows->getFlowRelationshipsFlowActions($id, $filter=$filter, $page_size=$page_size, $sort=$sort);

获取流程与标签关系

## Positional Arguments

# $id | string

$klaviyo->Flows->getFlowRelationshipsTags($id);

获取流程标签

## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_tag | string[]

$klaviyo->Flows->getFlowTags($id, $fields_tag=$fields_tag);

获取流程

## Keyword Arguments

# $fields_flow_action | string[]
# $fields_flow | string[]
# $fields_tag | string[]
# $filter | string
# $include | string[]
# $page_cursor | string
# $page_size | int
# $sort | string

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

更新流程状态

## Positional Arguments

# $id | string
# $body | associative array

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

表单

获取表单

## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_form_version | string[]
# $fields_form | string[]
# $include | string[]

$klaviyo->Forms->getForm($id, $fields_form_version=$fields_form_version, $fields_form=$fields_form, $include=$include);

获取表单版本对应的表单

## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_form | string[]

$klaviyo->Forms->getFormForFormVersion($id, $fields_form=$fields_form);

方法别名

$klaviyo->Forms->getFormVersionForm($id, $fields_form=$fields_form);

获取表单版本对应的表单ID

## Positional Arguments

# $id | string

$klaviyo->Forms->getFormIdForFormVersion($id);

方法别名

$klaviyo->Forms->getFormVersionRelationshipsForm($id);

获取表单版本

## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_form_version | string[]

$klaviyo->Forms->getFormVersion($id, $fields_form_version=$fields_form_version);

获取表单

## Keyword Arguments

# $fields_form | string[]
# $filter | string
# $page_cursor | string
# $page_size | int
# $sort | string

$klaviyo->Forms->getForms($fields_form=$fields_form, $filter=$filter, $page_cursor=$page_cursor, $page_size=$page_size, $sort=$sort);

获取表单的版本ID

## Positional Arguments

# $id | string

$klaviyo->Forms->getVersionIdsForForm($id);

方法别名

$klaviyo->Forms->getFormRelationshipsFormVersions($id);

获取表单的版本

## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_form_version | string[]
# $filter | string
# $page_cursor | string
# $page_size | int
# $sort | string

$klaviyo->Forms->getVersionsForForm($id, $fields_form_version=$fields_form_version, $filter=$filter, $page_cursor=$page_cursor, $page_size=$page_size, $sort=$sort);

方法别名

$klaviyo->Forms->getFormFormVersions($id, $fields_form_version=$fields_form_version, $filter=$filter, $page_cursor=$page_cursor, $page_size=$page_size, $sort=$sort);

图像

获取图片

## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_image | string[]

$klaviyo->Images->getImage($id, $fields_image=$fields_image);

获取图片

## Keyword Arguments

# $fields_image | string[]
# $filter | string
# $page_cursor | string
# $page_size | int
# $sort | string

$klaviyo->Images->getImages($fields_image=$fields_image, $filter=$filter, $page_cursor=$page_cursor, $page_size=$page_size, $sort=$sort);

更新图片

## Positional Arguments

# $id | string
# $body | associative array

$klaviyo->Images->updateImage($id, $body);

从文件上传图片

## Positional Arguments

# $file | \SplFileObject

## Keyword Arguments

# $name | string
# $hidden | bool

$klaviyo->Images->uploadImageFromFile($file, $name=$name, $hidden=$hidden);

方法别名

$klaviyo->Images->createImageUpload($file, $name=$name, $hidden=$hidden);

从URL上传图片

## Positional Arguments

# $body | associative array

$klaviyo->Images->uploadImageFromUrl($body);

方法别名

$klaviyo->Images->createImage($body);

列表

创建列表

## Positional Arguments

# $body | associative array

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

将配置文件添加到列表

## Positional Arguments

# $id | string
# $body | associative array

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

方法别名

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

删除列表

## Positional Arguments

# $id | string

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

从列表中删除配置文件

## Positional Arguments

# $id | string
# $body | associative array

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

方法别名

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

获取列表

## Positional Arguments

# $id | string

## Keyword Arguments

# $additional_fields_list | string[]
# $fields_list | string[]
# $fields_tag | string[]
# $include | string[]

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

获取列表配置文件

## Positional Arguments

# $id | string

## Keyword Arguments

# $additional_fields_profile | string[]
# $fields_profile | string[]
# $filter | string
# $page_cursor | string
# $page_size | int
# $sort | string

$klaviyo->Lists->getListProfiles($id, $additional_fields_profile=$additional_fields_profile, $fields_profile=$fields_profile, $filter=$filter, $page_cursor=$page_cursor, $page_size=$page_size, $sort=$sort);

获取列表与配置文件关系

## Positional Arguments

# $id | string

## Keyword Arguments

# $filter | string
# $page_cursor | string
# $page_size | int
# $sort | string

$klaviyo->Lists->getListRelationshipsProfiles($id, $filter=$filter, $page_cursor=$page_cursor, $page_size=$page_size, $sort=$sort);

获取列表与标签关系

## Positional Arguments

# $id | string

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

获取列表标签

## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_tag | string[]

$klaviyo->Lists->getListTags($id, $fields_tag=$fields_tag);

获取列表

## Keyword Arguments

# $fields_list | string[]
# $fields_tag | string[]
# $filter | string
# $include | string[]
# $page_cursor | string
# $sort | string

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

更新列表

## 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);

方法别名

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

配置文件

创建或更新配置文件

## Positional Arguments

# $body | associative array

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

方法别名

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

创建配置文件

## Positional Arguments

# $body | associative array

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

创建或更新推送令牌

## Positional Arguments

# $body | associative array

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

获取批量配置文件导入作业

## Positional Arguments

# $job_id | string

## Keyword Arguments

# $fields_list | string[]
# $fields_profile_bulk_import_job | string[]
# $include | string[]

$klaviyo->Profiles->getBulkProfileImportJob($job_id, $fields_list=$fields_list, $fields_profile_bulk_import_job=$fields_profile_bulk_import_job, $include=$include);

方法别名

$klaviyo->Profiles->getProfileBulkImportJob($job_id, $fields_list=$fields_list, $fields_profile_bulk_import_job=$fields_profile_bulk_import_job, $include=$include);

获取批量配置文件导入作业错误

## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_import_error | string[]
# $page_cursor | string
# $page_size | int

$klaviyo->Profiles->getBulkProfileImportJobImportErrors($id, $fields_import_error=$fields_import_error, $page_cursor=$page_cursor, $page_size=$page_size);

方法别名

$klaviyo->Profiles->getProfileBulkImportJobImportErrors($id, $fields_import_error=$fields_import_error, $page_cursor=$page_cursor, $page_size=$page_size);

获取批量配置文件导入作业列表

## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_list | string[]

$klaviyo->Profiles->getBulkProfileImportJobLists($id, $fields_list=$fields_list);

方法别名

$klaviyo->Profiles->getProfileBulkImportJobLists($id, $fields_list=$fields_list);

获取批量配置文件导入作业配置文件

## Positional Arguments

# $id | string

## Keyword Arguments

# $additional_fields_profile | string[]
# $fields_profile | string[]
# $page_cursor | string
# $page_size | int

$klaviyo->Profiles->getBulkProfileImportJobProfiles($id, $additional_fields_profile=$additional_fields_profile, $fields_profile=$fields_profile, $page_cursor=$page_cursor, $page_size=$page_size);

方法别名

$klaviyo->Profiles->getProfileBulkImportJobProfiles($id, $additional_fields_profile=$additional_fields_profile, $fields_profile=$fields_profile, $page_cursor=$page_cursor, $page_size=$page_size);

获取批量配置文件导入作业与列表关系

## Positional Arguments

# $id | string

$klaviyo->Profiles->getBulkProfileImportJobRelationshipsLists($id);

方法别名

$klaviyo->Profiles->getProfileBulkImportJobRelationshipsLists($id);

获取批量配置文件导入作业与配置文件关系

## Positional Arguments

# $id | string

## Keyword Arguments

# $page_cursor | string
# $page_size | int

$klaviyo->Profiles->getBulkProfileImportJobRelationshipsProfiles($id, $page_cursor=$page_cursor, $page_size=$page_size);

方法别名

$klaviyo->Profiles->getProfileBulkImportJobRelationshipsProfiles($id, $page_cursor=$page_cursor, $page_size=$page_size);

获取批量配置文件导入作业

## Keyword Arguments

# $fields_profile_bulk_import_job | string[]
# $filter | string
# $page_cursor | string
# $page_size | int
# $sort | string

$klaviyo->Profiles->getBulkProfileImportJobs($fields_profile_bulk_import_job=$fields_profile_bulk_import_job, $filter=$filter, $page_cursor=$page_cursor, $page_size=$page_size, $sort=$sort);

方法别名

$klaviyo->Profiles->getProfileBulkImportJobs($fields_profile_bulk_import_job=$fields_profile_bulk_import_job, $filter=$filter, $page_cursor=$page_cursor, $page_size=$page_size, $sort=$sort);

获取配置文件

## Positional Arguments

# $id | string

## Keyword Arguments

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

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

获取配置文件列表

## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_list | string[]

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

获取配置文件与列表关系

## Positional Arguments

# $id | string

$klaviyo->Profiles->getProfileRelationshipsLists($id);

获取配置文件与段关系

## Positional Arguments

# $id | string

$klaviyo->Profiles->getProfileRelationshipsSegments($id);

获取配置文件段

## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_segment | string[]

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

获取配置文件

## Keyword Arguments

# $additional_fields_profile | string[]
# $fields_profile | string[]
# $filter | string
# $page_cursor | string
# $page_size | int
# $sort | string

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

合并配置文件

## Positional Arguments

# $body | associative array

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

方法别名

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

创建批量配置文件导入作业

## Positional Arguments

# $body | associative array

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

方法别名

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

订阅配置文件

## Positional Arguments

# $body | associative array

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

方法别名

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

压制配置文件

## Positional Arguments

# $body | associative array

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

方法别名

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

取消订阅配置文件

## Positional Arguments

# $body | associative array

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

方法别名

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

取消压制配置文件

## Positional Arguments

# $body | associative array

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

方法别名

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

更新配置文件

## Positional Arguments

# $id | string
# $body | associative array

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

报告

查询活动值

## Positional Arguments

# $body | associative array

## Keyword Arguments

# $page_cursor | string

$klaviyo->Reporting->queryCampaignValues($body, $page_cursor=$page_cursor);

方法别名

$klaviyo->Reporting->createCampaignValueReport($body, $page_cursor=$page_cursor);

查询流程系列

## Positional Arguments

# $body | associative array

## Keyword Arguments

# $page_cursor | string

$klaviyo->Reporting->queryFlowSeries($body, $page_cursor=$page_cursor);

方法别名

$klaviyo->Reporting->createFlowSeryReport($body, $page_cursor=$page_cursor);

查询流程值

## Positional Arguments

# $body | associative array

## Keyword Arguments

# $page_cursor | string

$klaviyo->Reporting->queryFlowValues($body, $page_cursor=$page_cursor);

方法别名

$klaviyo->Reporting->createFlowValueReport($body, $page_cursor=$page_cursor);

段

创建段

## Positional Arguments

# $body | associative array

$klaviyo->Segments->createSegment($body);

删除段

## Positional Arguments

# $id | string

$klaviyo->Segments->deleteSegment($id);

获取段

## Positional Arguments

# $id | string

## Keyword Arguments

# $additional_fields_segment | string[]
# $fields_segment | string[]
# $fields_tag | string[]
# $include | string[]

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

获取段配置文件

## Positional Arguments

# $id | string

## Keyword Arguments

# $additional_fields_profile | string[]
# $fields_profile | string[]
# $filter | string
# $page_cursor | string
# $page_size | int
# $sort | string

$klaviyo->Segments->getSegmentProfiles($id, $additional_fields_profile=$additional_fields_profile, $fields_profile=$fields_profile, $filter=$filter, $page_cursor=$page_cursor, $page_size=$page_size, $sort=$sort);

获取段与配置文件关系

## Positional Arguments

# $id | string

## Keyword Arguments

# $filter | string
# $page_cursor | string
# $page_size | int
# $sort | string

$klaviyo->Segments->getSegmentRelationshipsProfiles($id, $filter=$filter, $page_cursor=$page_cursor, $page_size=$page_size, $sort=$sort);

获取段与标签关系

## Positional Arguments

# $id | string

$klaviyo->Segments->getSegmentRelationshipsTags($id);

获取段标签

## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_tag | string[]

$klaviyo->Segments->getSegmentTags($id, $fields_tag=$fields_tag);

获取段

## Keyword Arguments

# $fields_segment | string[]
# $fields_tag | string[]
# $filter | string
# $include | string[]
# $page_cursor | string
# $sort | string

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

更新段

## Positional Arguments

# $id | string
# $body | associative array

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

## Keyword Arguments

# $fields_tag_group | string[]
# $fields_tag | string[]
# $filter | string
# $include | string[]
# $page_cursor | string
# $sort | string

$klaviyo->Tags->getTags($fields_tag_group=$fields_tag_group, $fields_tag=$fields_tag, $filter=$filter, $include=$include, $page_cursor=$page_cursor, $sort=$sort);

更新标签

## Positional Arguments

# $id | string
# $body | associative array

$klaviyo->Tags->updateTag($id, $body);

更新标签组

## Positional Arguments

# $id | string
# $body | associative array

$klaviyo->Tags->updateTagGroup($id, $body);

模板

创建模板

## Positional Arguments

# $body | associative array

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

创建模板克隆

## Positional Arguments

# $body | associative array

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

创建模板渲染

## Positional Arguments

# $body | associative array

$klaviyo->Templates->createTemplateRender($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);

Webhooks

创建Webhook

## Positional Arguments

# $body | associative array

$klaviyo->Webhooks->createWebhook($body);

删除Webhook

## Positional Arguments

# $id | string

$klaviyo->Webhooks->deleteWebhook($id);

获取Webhook

## Positional Arguments

# $id | string

## Keyword Arguments

# $fields_webhook | string[]
# $include | string[]

$klaviyo->Webhooks->getWebhook($id, $fields_webhook=$fields_webhook, $include=$include);

获取Webhook主题

## Positional Arguments

# $id | string

$klaviyo->Webhooks->getWebhookTopic($id);

获取Webhook主题列表

$klaviyo->Webhooks->getWebhookTopics();

获取Webhook列表

## Keyword Arguments

# $fields_webhook | string[]
# $include | string[]

$klaviyo->Webhooks->getWebhooks($fields_webhook=$fields_webhook, $include=$include);

更新Webhook

## Positional Arguments

# $id | string
# $body | associative array

$klaviyo->Webhooks->updateWebhook($id, $body);

附录

全局关键字参数

注意

这些是可以应用于任何端点调用，并且只针对SDK的独特参数。
它们在下面列出的所有端点特定的关键字参数之后，按照相同的顺序排列。
它们受到与其他PHP关键字参数相同的怪癖影响，即要包含在内，它们需要在前面的所有关键字参数之前，这包括给定端点的所有端点特定的关键字参数，以及下面列出的任何先前的全局关键字参数（如果适用）。即使那些其他关键字参数没有被使用，这也成立；在这种情况下，将它们设置为null，但再次强调，它们必须被包含。

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

$apiKey：使用此参数覆盖在客户端实例化时定义的api_key。

命名空间

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

从函数名称（操作ID）中移除下划线
函数名称使用驼峰式（例如getMetrics）
资源名称使用大驼峰式（例如Metrics）
参数名称保持不变

参数与参数

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

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

klaviyo / api

维护者

详细信息

README

有帮助的资源

设计 & 方法

组织

安装

用法示例

用例示例

如何使用过滤、排序和备用字段集 JSON API 功能

如何根据 datetime 进行过滤

如何使用分页和 page[size] 参数

如何通过 additional-fields 和 includes 参数向 API 响应添加更多信息

如何使用我们的关系端点查看相关资源

如何查看与特定标签关联的 Klaviyo 对象

从文件上传图像

重试行为

错误处理

重要提示

操作与参数的完整列表

账户

活动

目录

方法别名

方法别名

方法别名

方法别名

方法别名

方法别名

方法别名

方法别名

方法别名

方法别名

方法别名

方法别名

方法别名

方法别名

方法别名

方法别名

方法别名

方法别名

方法别名

方法别名

方法别名

方法别名

方法别名

方法别名

方法别名

方法别名

方法别名

方法别名

方法别名

优惠券

方法别名

方法别名