オフセットベースのページネーションの制限事項

発表日	展開開始日（段階的）
2023年5月22日	2024年5月20日 - EU以外の地域 - 完了 2024年9月9日 - EU地域 - 完了

Zendeskは現在、ほとんどのAPIエンドポイントでオフセットベースのページネーション（OBP）とカーソルベースのページネーション（CBP）の両方を提供しています。CBPには、OBPに比べて多くの利点があり、近い将来、CPBをZendeskで提供される主要なページネーションの方法にする予定です。カスタマーにより優れた迅速なエクスペリエンスを提供するために、CBPへの移行を促進するための措置を講じています。まず、オフセット値が高いOBPリクエストに対する制限を厳しくします。

このお知らせでは、以下の内容について回答いたします。

• 変更内容
• Zendeskがこれらの変更を行う理由
• 必要となる作業

変更内容

2024年5月20日以降、最初の10,000件のレコード（100ページ）を超えるOBPリクエストを行うと、次のエラーメッセージが表示されます：「400 不正なリクエスト」10,000件のレコードを超えるデータセットをリクエストするには、カスタマーはCBPに移行する必要があります。

今回の変更は、レコード数が10,000件未満のOBPリクエストや、CBPモデルを使用して行われたリクエストには影響しません。 

Zendeskがこの変更を行う理由

今回の変更は、CBPの採用を推奨し、カスタマーにできるだけ早くCBPへの切り替えを行うことをお勧めする前回の発表の内容に沿って行われています。

カーソルベースのページネーションは、カスタマーにとってより高速で効率的です。また、Zendeskインフラストラクチャへの負荷が軽減され、安定性と信頼性が向上します。最初のステップとして、現在のAPI使用における混乱の発生を最小限に抑えながら移行を実行できるように、オフセットベースのページネーション機能を比較的高い水準で制限しています。 

必要となる作業

Zendeskでは、2024年5月20日までにカーソルベースのページネーションへの移行を強くお勧めしています。制限を超えている可能性があるインテグレーションやアプリケーションが分からない場合は、Zendeskインテグレーションとアプリの管理を担当する自社のチームと協力して、この変更による影響を調査し、判断することをお勧めします。

Zendeskは引き続きオフセットページネーションを提供します。ただし、パフォーマンスの高いカーソルページネーションの採用を促進し、リクエストへの応答時間を改善するために、近い将来にはページの深さを大幅に制限する予定です。 

ご質問がある場合、または別途サポートが必要な場合は、お気軽にお問い合わせください。Zendeskに連絡するには、Web Widgetを使用してください。

段階的に展開を開始することで、すべてのユーザーにとってシームレスな移行を実現します。EU地域のアカウントに関する変更は、3か月後（2024年9月9日）にリリースを予定しています。 

クライアントライブラリ/SDKで利用可能なアップデート

Zendeskは公式Rubyクライアントを更新し、コミュニティSDKの開発者と提携してCBPのサポートを提供しました。これらのライブラリのいずれかを使用している場合は、確認、テスト、最新バージョンへの更新を行ってください。

ライブラリ	役に立つ手順
Ruby	Zendesk APIクライアント >=3.0.4によるカーソルページネーションのサポート Wikiの「一般的な使用方法」を参照してください。
Python	Zen Py >=v2.0.34によるカーソルページネーションのサポート pip install zenpy --upgrade Or pip install zenpy==2.0.46(latest version as of this writing)
NodeJS	ノードZendesk >=v3.0.2によるカーソルページネーションのサポート。こちらのリリースタグを参照してください。 npm update node-zendesk
Java	Zendesk Javaクライアント >= v0.24.1によるカーソルページネーションのサポート。こちらのリリースタグを参照してください。 Mavenの使用 <!-- https://mvnrepository.com/artifact/com.cloudbees.thirdparty/zendesk-java-client --> <dependency> <groupid>com.cloudbees.thirdparty</groupid> <artifactid>zendesk-java-client</artifactid> <version>0.24.1</version> </dependency>
PHP	ZendeskAPI PHPクライアント >= 3.0.01によるカーソルページネーションのサポート composer require zendesk/zendesk_api_client_php:^3.0.1 「アップグレードガイド」を参照してください。
MS BIコネクタ	新しく改善されたZendeskデータコネクタは、1000行を超えるレコードを取得する機能を備えており、カーソルモデルを使用してデータをすばやく取得できます。 最新のコネクタの使用方法については、「移行ガイド」を参照してください。
Go Lang	go-zendesk >=v0.18.0 「アップグレードガイド」を参照してください
C#	ZendeskApiクライアント >= 7.0.7によるカーソルページネーションのサポート  カーソルベースのページネーションの使用方法については、READMEセクションを参照してください

CBP機能を備えたエンドポイント

製品	エンドポイント
チケッティング	/api/v2/activities
チケッティング	/api/v2/audit_logs
チケッティング	/api/v2/automations
チケッティング	/api/v2/automations/active
チケッティング	/api/v2/brands
チケッティング	/api/v2/custom_objects/:custom_object_key/fields
チケッティング	/api/v2/custom_objects/:custom_object_key/records
チケッティング	/api/v2/custom_objects/:custom_object_key/records/autocomplete
チケッティング	/api/v2/custom_objects/:custom_object_key/records/search
チケッティング	/api/v2/custom_objects/:custom_object_key/triggers
チケッティング	/api/v2/custom_objects/:custom_object_key/triggers/active
チケッティング	/api/v2/deleted_tickets
チケッティング	/api/v2/deleted_users
チケッティング	/api/v2/deletion_schedules
チケッティング	/api/v2/dynamic_content/items
チケッティング	/api/v2/dynamic_content/items/:item_id/variants
チケッティング	/api/v2/end_users/:end_user_id/identities
チケッティング	/api/v2/group_memberships
チケッティング	/api/v2/group_memberships/assignable
チケッティング	/api/v2/groups
チケッティング	/api/v2/groups/:group_id/memberships
チケッティング	/api/v2/groups/:group_id/memberships/assignable
チケッティング	/api/v2/groups/:group_id/users
チケッティング	/api/v2/groups/assignable
チケッティング	/api/v2/groups/available_agents
チケッティング	/api/v2/incremental/ticket_metric_events
チケッティング	/api/v2/job_statuses
チケッティング	/api/v2/macros
チケッティング	/api/v2/macros/active
チケッティング	/api/v2/macros/groups
チケッティング	/api/v2/organization_fields
チケッティング	/api/v2/organization_memberships
チケッティング	/api/v2/organization_subscriptions
チケッティング	/api/v2/organizations
チケッティング	/api/v2/organizations/:organization_id/organization_memberships
チケッティング	/api/v2/organizations/:organization_id/requests
チケッティング	/api/v2/organizations/:organization_id/subscriptions
チケッティング	/api/v2/organizations/:organization_id/tickets
チケッティング	/api/v2/organizations/:organization_id/users
チケッティング	/api/v2/problems
チケッティング	/api/v2/recipient_addresses
チケッティング	/api/v2/requests
チケッティング	/api/v2/requests/:request_id/comments
チケッティング	/api/v2/requests/ccd
チケッティング	/api/v2/requests/open
チケッティング	/api/v2/requests/solved
チケッティング	/api/v2/satisfaction_ratings
チケッティング	/api/v2/search/export
チケッティング	/api/v2/sessions
チケッティング	/api/v2/skips
チケッティング	/api/v2/suspended_tickets
チケッティング	/api/v2/tags
チケッティング	/api/v2/:target_type/:target_id/relationship_fields/:field_id/:source_type
チケッティング	/api/v2/ticket_audits
チケッティング	/api/v2/ticket_content_pins
チケッティング	/api/v2/ticket_fields
チケッティング	/api/v2/ticket_fields/:ticket_field_id/options
チケッティング	/api/v2/ticket_metrics
チケッティング	/api/v2/tickets
チケッティング	/api/v2/tickets/:ticket_id/audits
チケッティング	/api/v2/tickets/:ticket_id/comments
チケッティング	/api/v2/tickets/:ticket_id/incidents
チケッティング	/api/v2/tickets/:ticket_id/skips
チケッティング	/api/v2/trigger_categories
チケッティング	/api/v2/triggers
チケッティング	/api/v2/triggers/active
チケッティング	/api/v2/user_fields
チケッティング	/api/v2/user_fields/:user_field_id/options
チケッティング	/api/v2/users
チケッティング	/api/v2/users/:user_id/group_memberships
チケッティング	/api/v2/users/:user_id/groups
チケッティング	/api/v2/users/:user_id/identities
チケッティング	/api/v2/users/:user_id/organization_memberships
チケッティング	/api/v2/users/:user_id/organization_subscriptions
チケッティング	/api/v2/users/:user_id/organizations
チケッティング	/api/v2/users/:user_id/requests
チケッティング	/api/v2/users/:user_id/sessions
チケッティング	/api/v2/users/:user_id/skips
チケッティング	/api/v2/users/:user_id/tickets/assigned
チケッティング	/api/v2/users/:user_id/tickets/ccd
チケッティング	/api/v2/users/:user_id/tickets/requested
チケッティング	/api/v2/views
チケッティング	/api/v2/views/:id/execute
チケッティング	/api/v2/views/:id/tickets

製品	エンドポイント
ヘルプセンター	/hc/api/v2/incremental/articles
ヘルプセンター	/hc/api/v2/articles/attachments/:id
ヘルプセンター	/hc/api/v2/articles/labels
ヘルプセンター	/hc/api/v2/articles/labels/:id
ヘルプセンター	/hc/api/v2/articles/:article_id/translations/missing
ヘルプセンター	/hc/api/v2/articles/:article_id/translations
ヘルプセンター	/hc/api/v2/articles/:article_id/translations/:id
ヘルプセンター	/hc/api/v2/categories/:category_id/translations/missing
ヘルプセンター	/hc/api/v2/categories/:category_id/translations
ヘルプセンター	/hc/api/v2/categories/:category_id/translations/:id
ヘルプセンター	/hc/api/v2/user_segments/applicable
ヘルプセンター	/hc/api/v2/user_segments/:user_segment_id/sections
ヘルプセンター	/hc/api/v2/user_segments/:user_segment_id/topics
ヘルプセンター	/hc/api/v2/user_segments
ヘルプセンター	/hc/api/v2/user_segments/:id
ヘルプセンター	/hc/api/v2/sections/:section_id/translations/missing
ヘルプセンター	/hc/api/v2/sections/:section_id/translations
ヘルプセンター	/hc/api/v2/sections/:section_id/translations/:id
ヘルプセンター	/hc/api/v2(/:locale)/articles/:article_id/attachments/:scope
ヘルプセンター	/hc/api/v2(/:locale)/articles/:article_id/attachments
ヘルプセンター	/hc/api/v2(/:locale)/articles/:article_id/attachments/:id
ヘルプセンター	/hc/api/v2(/:locale)/articles/:article_id/labels
ヘルプセンター	/hc/api/v2(/:locale)/articles/:article_id/comments/:comment_id/votes
ヘルプセンター	/hc/api/v2(/:locale)/articles/:article_id/comments
ヘルプセンター	/hc/api/v2(/:locale)/articles/:article_id/comments/:id
ヘルプセンター	/hc/api/v2(/:locale)/articles/:article_id/votes
ヘルプセンター	/hc/api/v2(/:locale)/articles/:article_id/subscriptions
ヘルプセンター	/hc/api/v2(/:locale)/articles/:article_id/subscriptions/:id
ヘルプセンター	/hc/api/v2(/:locale)/articles
ヘルプセンター	/hc/api/v2(/:locale)/articles/:id
ヘルプセンター	/hc/api/v2(/:locale)/categories/:category_id/articles
ヘルプセンター	/hc/api/v2(/:locale)/categories/:category_id/sections
ヘルプセンター	/hc/api/v2(/:locale)/categories
ヘルプセンター	/hc/api/v2(/:locale)/categories/:id
ヘルプセンター	/hc/api/v2(/:locale)/sections/:section_id/articles
ヘルプセンター	/hc/api/v2(/:locale)/sections/:section_id/subscriptions
ヘルプセンター	/hc/api/v2(/:locale)/sections/:section_id/subscriptions/:id
ヘルプセンター	/hc/api/v2(/:locale)/sections
ヘルプセンター	/hc/api/v2(/:locale)/sections/:id
ヘルプセンター	/hc/api/v2/community/posts/:post_id/comments/:comment_id/votes
ヘルプセンター	/hc/api/v2/community/posts/:post_id/comments
ヘルプセンター	/hc/api/v2/community/posts/:post_id/comments/:id
ヘルプセンター	/hc/api/v2/community/posts/:post_id/subscriptions
ヘルプセンター	/hc/api/v2/community/posts/:post_id/subscriptions/:id
ヘルプセンター	/hc/api/v2/community/posts/:post_id/votes
ヘルプセンター	/hc/api/v2/community/posts
ヘルプセンター	/hc/api/v2/community/posts/:id
ヘルプセンター	/hc/api/v2/community/topics/:topic_id/subscriptions
ヘルプセンター	/hc/api/v2/community/topics/:topic_id/subscriptions/:id
ヘルプセンター	/hc/api/v2/community/topics/:topic_id/posts
ヘルプセンター	/hc/api/v2/community/topics
ヘルプセンター	/hc/api/v2/community/topics/:id
ヘルプセンター	/hc/api/v2/community/users/:user_id/posts
ヘルプセンター	/hc/api/v2/community/users/:user_id/comments
ヘルプセンター	/hc/api/v2/users/:user_id/articles
ヘルプセンター	/hc/api/v2/users/:user_id/subscriptions
ヘルプセンター	/hc/api/v2/users/:user_id/user_subscriptions
ヘルプセンター	/hc/api/v2/users/:user_id/comments
ヘルプセンター	/hc/api/v2/users/:user_id/votes
ヘルプセンター	/hc/api/v2/users/:user_id/user_segments
ヘルプセンター	/hc/api/v2/votes
ヘルプセンター	/hc/api/v2/votes/:id