Skip to main content

Summary

List all caption paragraphs in the document.
  • Operation ID: captions.list
  • API member path: editor.doc.captions.list(...)
  • Mutates document: no
  • Idempotency: idempotent
  • Supports tracked mode: no
  • Supports dry run: no
  • Deterministic target resolution: yes

Expected result

Returns a CaptionsListResult containing discovered captions with address and domain data.

Input fields

Example request

Output fields

No fields.

Example response

Pre-apply throws

  • CAPABILITY_UNAVAILABLE
  • INVALID_INPUT

Non-applied failure codes

  • None

Raw schemas