Variable CanonicalFormatConst

Type Declaration

• Readonlyref: (
      agent_url: string,
      id: string,
      fields?: Omit<Partial<FormatReferenceStructuredObject>, "agent_url" | "id"> & Record<
          string,
          unknown,
      >,
  ) => FormatReferenceStructuredObject

• Readonlyrefs: (...refs: FormatReferenceInput[]) => FormatReferenceStructuredObject[]

• Readonlydeclaration: <K extends keyof CanonicalFormatDeclarationMap>(
      format_kind: K,
      params: CanonicalFormatParams<K>,
      fields?: CanonicalFormatDeclarationFields<K>,
  ) => CanonicalFormatDeclaration<K>

• Readonlyimage: (
      params: CanonicalFormatImage,
      fields?: CanonicalFormatDeclarationFields<"image">,
  ) => {
      format_option_id?: string;
      publisher_domain?: string;
      display_name?: string;
      applies_to_channels?: MediaChannel[];
      seller_preference?: "preferred" | "accepted" | "discouraged";
      canonical_formats_only?: boolean;
      experimental?: boolean;
      format_shape?: string;
      v1_format_ref?: FormatReferenceStructuredObject[];
      format_schema?: PlatformExtensionReference;
      format_kind: "image";
      params: CanonicalFormatImage;
  }

• Readonlyhtml5: (
      params: CanonicalFormatHTML5Banner,
      fields?: CanonicalFormatDeclarationFields<"html5">,
  ) => {
      format_option_id?: string;
      publisher_domain?: string;
      display_name?: string;
      applies_to_channels?: MediaChannel[];
      seller_preference?: "preferred" | "accepted" | "discouraged";
      canonical_formats_only?: boolean;
      experimental?: boolean;
      format_shape?: string;
      v1_format_ref?: FormatReferenceStructuredObject[];
      format_schema?: PlatformExtensionReference;
      format_kind: "html5";
      params: CanonicalFormatHTML5Banner;
  }

• ReadonlydisplayTag: (
      params: CanonicalFormatDisplayTag,
      fields?: CanonicalFormatDeclarationFields<"display_tag">,
  ) => {
      format_option_id?: string;
      publisher_domain?: string;
      display_name?: string;
      applies_to_channels?: MediaChannel[];
      seller_preference?: "preferred" | "accepted" | "discouraged";
      canonical_formats_only?: boolean;
      experimental?: boolean;
      format_shape?: string;
      v1_format_ref?: FormatReferenceStructuredObject[];
      format_schema?: PlatformExtensionReference;
      format_kind: "display_tag";
      params: CanonicalFormatDisplayTag;
  }

• ReadonlyimageCarousel: (
      params: CanonicalFormatImageCarousel,
      fields?: CanonicalFormatDeclarationFields<"image_carousel">,
  ) => {
      format_option_id?: string;
      publisher_domain?: string;
      display_name?: string;
      applies_to_channels?: MediaChannel[];
      seller_preference?: "preferred" | "accepted" | "discouraged";
      canonical_formats_only?: boolean;
      experimental?: boolean;
      format_shape?: string;
      v1_format_ref?: FormatReferenceStructuredObject[];
      format_schema?: PlatformExtensionReference;
      format_kind: "image_carousel";
      params: CanonicalFormatImageCarousel;
  }

• ReadonlyvideoHosted: (
      params: CanonicalFormatHostedVideo,
      fields?: CanonicalFormatDeclarationFields<"video_hosted">,
  ) => {
      format_option_id?: string;
      publisher_domain?: string;
      display_name?: string;
      applies_to_channels?: MediaChannel[];
      seller_preference?: "preferred" | "accepted" | "discouraged";
      canonical_formats_only?: boolean;
      experimental?: boolean;
      format_shape?: string;
      v1_format_ref?: FormatReferenceStructuredObject[];
      format_schema?: PlatformExtensionReference;
      format_kind: "video_hosted";
      params: CanonicalFormatHostedVideo;
  }

• ReadonlyvideoVast: (
      params: CanonicalFormatVASTVideo,
      fields?: CanonicalFormatDeclarationFields<"video_vast">,
  ) => {
      format_option_id?: string;
      publisher_domain?: string;
      display_name?: string;
      applies_to_channels?: MediaChannel[];
      seller_preference?: "preferred" | "accepted" | "discouraged";
      canonical_formats_only?: boolean;
      experimental?: boolean;
      format_shape?: string;
      v1_format_ref?: FormatReferenceStructuredObject[];
      format_schema?: PlatformExtensionReference;
      format_kind: "video_vast";
      params: CanonicalFormatVASTVideo;
  }

• ReadonlyaudioHosted: (
      params: CanonicalFormatHostedAudio,
      fields?: CanonicalFormatDeclarationFields<"audio_hosted">,
  ) => {
      format_option_id?: string;
      publisher_domain?: string;
      display_name?: string;
      applies_to_channels?: MediaChannel[];
      seller_preference?: "preferred" | "accepted" | "discouraged";
      canonical_formats_only?: boolean;
      experimental?: boolean;
      format_shape?: string;
      v1_format_ref?: FormatReferenceStructuredObject[];
      format_schema?: PlatformExtensionReference;
      format_kind: "audio_hosted";
      params: CanonicalFormatHostedAudio;
  }

• ReadonlyaudioDaast: (
      params: CanonicalFormatDAASTAudio,
      fields?: CanonicalFormatDeclarationFields<"audio_daast">,
  ) => {
      format_option_id?: string;
      publisher_domain?: string;
      display_name?: string;
      applies_to_channels?: MediaChannel[];
      seller_preference?: "preferred" | "accepted" | "discouraged";
      canonical_formats_only?: boolean;
      experimental?: boolean;
      format_shape?: string;
      v1_format_ref?: FormatReferenceStructuredObject[];
      format_schema?: PlatformExtensionReference;
      format_kind: "audio_daast";
      params: CanonicalFormatDAASTAudio;
  }

• ReadonlysponsoredPlacement: (
      params: CanonicalFormatSponsoredPlacementRetailMediaCatalogDriven,
      fields?: CanonicalFormatDeclarationFields<"sponsored_placement">,
  ) => {
      format_option_id?: string;
      publisher_domain?: string;
      display_name?: string;
      applies_to_channels?: MediaChannel[];
      seller_preference?: "preferred" | "accepted" | "discouraged";
      canonical_formats_only?: boolean;
      experimental?: boolean;
      format_shape?: string;
      v1_format_ref?: FormatReferenceStructuredObject[];
      format_schema?: PlatformExtensionReference;
      format_kind: "sponsored_placement";
      params: CanonicalFormatSponsoredPlacementRetailMediaCatalogDriven;
  }

• ReadonlynativeInFeed: (
      params: CanonicalFormatNativeInFeed,
      fields?: CanonicalFormatDeclarationFields<"native_in_feed">,
  ) => {
      format_option_id?: string;
      publisher_domain?: string;
      display_name?: string;
      applies_to_channels?: MediaChannel[];
      seller_preference?: "preferred" | "accepted" | "discouraged";
      canonical_formats_only?: boolean;
      experimental?: boolean;
      format_shape?: string;
      v1_format_ref?: FormatReferenceStructuredObject[];
      format_schema?: PlatformExtensionReference;
      format_kind: "native_in_feed";
      params: CanonicalFormatNativeInFeed;
  }

• ReadonlyresponsiveCreative: (
      params: CanonicalFormatResponsiveCreative,
      fields?: CanonicalFormatDeclarationFields<"responsive_creative">,
  ) => {
      format_option_id?: string;
      publisher_domain?: string;
      display_name?: string;
      applies_to_channels?: MediaChannel[];
      seller_preference?: "preferred" | "accepted" | "discouraged";
      canonical_formats_only?: boolean;
      experimental?: boolean;
      format_shape?: string;
      v1_format_ref?: FormatReferenceStructuredObject[];
      format_schema?: PlatformExtensionReference;
      format_kind: "responsive_creative";
      params: CanonicalFormatResponsiveCreative;
  }

• ReadonlyagentPlacement: (
      params: CanonicalFormatAgentPlacementAISurfaceSponsoredPlacement,
      fields?: CanonicalFormatDeclarationFields<"agent_placement">,
  ) => {
      format_option_id?: string;
      publisher_domain?: string;
      display_name?: string;
      applies_to_channels?: MediaChannel[];
      seller_preference?: "preferred" | "accepted" | "discouraged";
      canonical_formats_only?: boolean;
      experimental?: boolean;
      format_shape?: string;
      v1_format_ref?: FormatReferenceStructuredObject[];
      format_schema?: PlatformExtensionReference;
      format_kind: "agent_placement";
      params: CanonicalFormatAgentPlacementAISurfaceSponsoredPlacement;
  }

• Readonlycustom: (
      format_shape: string,
      format_schema: {},
      params: {},
      fields?: Omit<
          CanonicalFormatDeclarationFields<"custom">,
          "format_shape" | "format_schema",
      >,
  ) => {
      format_option_id?: string;
      publisher_domain?: string;
      display_name?: string;
      applies_to_channels?: MediaChannel[];
      seller_preference?: "preferred" | "accepted" | "discouraged";
      canonical_formats_only?: boolean;
      experimental?: boolean;
      format_shape?: string;
      v1_format_ref?: FormatReferenceStructuredObject[];
      format_schema?: PlatformExtensionReference;
      format_kind: "custom";
      params: {};
  }

• productCard: (fields: ProductCardFields) => ProductCardFields

• productCardDetailed: (fields: ProductCardDetailedFields) => ProductCardDetailedFields