@graph8/sdk 0.251.0 → 0.260.0

package/docs/api/adCampaigns.d.ts

@@ -0,0 +1,707 @@
+/* Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. */
+
+/**
+ * Types for `g8.api.adCampaigns` (Ad Campaigns): 19 operations.
+ *
+ * For reading. In code, import from the package instead:
+ *   import type { ApiInput, ApiOutput, G8Contract } from "@graph8/sdk";
+ *   type In = ApiInput<"archive_campaign_ad_ad_campaigns__campaign_id__ads__ad_id__delete">;
+ *
+ * Reference with examples: adCampaigns.md
+ */
+/* eslint-disable */
+
+/** `g8.api.adCampaigns.<member>` -> the operationId it calls. */
+export interface AdCampaignsMembers {
+  archiveCampaignAd: "archive_campaign_ad_ad_campaigns__campaign_id__ads__ad_id__delete";
+  createCampaignAd: "create_campaign_ad_ad_campaigns__campaign_id__ads_post";
+  createCampaignAdsBatch: "create_campaign_ads_batch_ad_campaigns__campaign_id__ads_batch_post";
+  deleteAdCampaign: "delete_ad_campaign_ad_campaigns__campaign_id__delete";
+  getAdCampaign: "get_ad_campaign_ad_campaigns__campaign_id__get";
+  getCampaignAd: "get_campaign_ad_ad_campaigns__campaign_id__ads__ad_id__get";
+  getCampaignEditableFields: "get_campaign_editable_fields_ad_campaigns__campaign_id__editable_get";
+  getPerCampaignMetrics: "get_per_campaign_metrics_ad_campaigns_metrics_get";
+  launchAdCampaign: "launch_ad_campaign_audience_syncs__config_id__launch_post";
+  listAdCampaigns: "list_ad_campaigns_ad_campaigns_get";
+  listCampaignAds: "list_campaign_ads_ad_campaigns__campaign_id__ads_get";
+  previewAdCampaignEdit: "preview_ad_campaign_edit_ad_campaigns__campaign_id__edit_preview_post";
+  refreshAllCampaignStatuses: "refresh_all_campaign_statuses_ad_campaigns_status_refresh_post";
+  refreshCampaignStatus: "refresh_campaign_status_ad_campaigns__campaign_id__status_refresh_post";
+  retryCampaignLaunch: "retry_campaign_launch_ad_campaigns__campaign_id__retry_post";
+  setCampaignAdStatus: "set_campaign_ad_status_ad_campaigns__campaign_id__ads__ad_id__status_post";
+  updateAdCampaign: "update_ad_campaign_ad_campaigns__campaign_id__put";
+  updateCampaignAd: "update_campaign_ad_ad_campaigns__campaign_id__ads__ad_id__patch";
+  uploadAdImage: "upload_ad_image_ad_campaigns_images_post";
+}
+
+/** Input and output of every `g8.api.adCampaigns` operation, keyed by operationId. */
+export interface AdCampaignsOperations {
+  /**
+   * DELETE /ad-campaigns/{campaign_id}/ads/{ad_id}
+   * Archive Campaign Ad
+   * tier: destructive · scope: ads:delete
+   */
+  archive_campaign_ad_ad_campaigns__campaign_id__ads__ad_id__delete: {
+    input: {
+    path: {
+      /** Ad campaign ID */
+      campaign_id: number;
+      /** graph8 ad ID */
+      ad_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_AdResponse_;
+  };
+  /**
+   * POST /ad-campaigns/{campaign_id}/ads
+   * Create Campaign Ad
+   * tier: external · scope: ads:run
+   */
+  create_campaign_ad_ad_campaigns__campaign_id__ads_post: {
+    input: {
+    path: {
+      /** Ad campaign ID */
+      campaign_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: AdCreateRequest;
+  };
+    output: ApiResponse_AdResponse_;
+  };
+  /**
+   * POST /ad-campaigns/{campaign_id}/ads/batch
+   * Create Campaign Ads Batch
+   * tier: external · scope: ads:run
+   */
+  create_campaign_ads_batch_ad_campaigns__campaign_id__ads_batch_post: {
+    input: {
+    path: {
+      /** Ad campaign ID */
+      campaign_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: AdBatchCreateRequest;
+  };
+    output: ApiResponse_AdBatchCreateResponse_;
+  };
+  /**
+   * DELETE /ad-campaigns/{campaign_id}
+   * Delete Ad Campaign
+   * tier: destructive · scope: ads:delete
+   */
+  delete_ad_campaign_ad_campaigns__campaign_id__delete: {
+    input: {
+    path: {
+      /** The ad campaign's id. */
+      campaign_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_AdPayload_;
+  };
+  /**
+   * GET /ad-campaigns/{campaign_id}
+   * Get Ad Campaign
+   * tier: read · scope: ads:read
+   */
+  get_ad_campaign_ad_campaigns__campaign_id__get: {
+    input: {
+    path: {
+      /** Ad campaign ID */
+      campaign_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_AdCampaignResponse_;
+  };
+  /**
+   * GET /ad-campaigns/{campaign_id}/ads/{ad_id}
+   * Get Campaign Ad
+   * tier: read · scope: ads:read
+   */
+  get_campaign_ad_ad_campaigns__campaign_id__ads__ad_id__get: {
+    input: {
+    path: {
+      /** Ad campaign ID */
+      campaign_id: number;
+      /** graph8 ad ID */
+      ad_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_AdResponse_;
+  };
+  /**
+   * GET /ad-campaigns/{campaign_id}/editable
+   * Get Campaign Editable Fields
+   * tier: read · scope: ads:read
+   */
+  get_campaign_editable_fields_ad_campaigns__campaign_id__editable_get: {
+    input: {
+    path: {
+      /** The ad campaign's id. */
+      campaign_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_AdPayload_;
+  };
+  /**
+   * GET /ad-campaigns/metrics
+   * Get Per Campaign Metrics
+   * tier: read · scope: ads:read
+   */
+  get_per_campaign_metrics_ad_campaigns_metrics_get: {
+    input: {
+    query?: {
+      /** Days to look back. */
+      days?: number;
+      /** One platform. Omit for all. */
+      platform?: ("meta" | "linkedin" | "google" | "x") | null;
+      ad_account_id?: string | null;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_AdPayload_;
+  };
+  /**
+   * POST /audience-syncs/{config_id}/launch
+   * Launch Ad Campaign
+   * tier: external · scope: ads:run
+   */
+  launch_ad_campaign_audience_syncs__config_id__launch_post: {
+    input: {
+    path: {
+      /** The sync config whose audience the campaign targets. */
+      config_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: LaunchAdCampaignRequest;
+  };
+    output: ApiResponse_AdPayload_;
+  };
+  /**
+   * GET /ad-campaigns
+   * List Ad Campaigns
+   * tier: read · scope: ads:read
+   */
+  list_ad_campaigns_ad_campaigns_get: {
+    input: {
+    query?: {
+      /** Filter by platform: google | linkedin */
+      platform?: string | null;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_list_AdCampaignResponse__;
+  };
+  /**
+   * GET /ad-campaigns/{campaign_id}/ads
+   * List Campaign Ads
+   * tier: read · scope: ads:read
+   */
+  list_campaign_ads_ad_campaigns__campaign_id__ads_get: {
+    input: {
+    path: {
+      /** Ad campaign ID */
+      campaign_id: number;
+    };
+    query?: {
+      include_archived?: boolean;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_AdListResponse_;
+  };
+  /**
+   * POST /ad-campaigns/{campaign_id}/edit-preview
+   * Preview Ad Campaign Edit
+   * tier: external · scope: ads:run
+   */
+  preview_ad_campaign_edit_ad_campaigns__campaign_id__edit_preview_post: {
+    input: {
+    path: {
+      /** The ad campaign's id. */
+      campaign_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: UpdateAdCampaignRequest;
+  };
+    output: ApiResponse_AdPayload_;
+  };
+  /**
+   * POST /ad-campaigns/status-refresh
+   * Refresh All Campaign Statuses
+   * tier: external · scope: ads:run
+   */
+  refresh_all_campaign_statuses_ad_campaigns_status_refresh_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_AdPayload_;
+  };
+  /**
+   * POST /ad-campaigns/{campaign_id}/status-refresh
+   * Refresh Campaign Status
+   * tier: external · scope: ads:run
+   */
+  refresh_campaign_status_ad_campaigns__campaign_id__status_refresh_post: {
+    input: {
+    path: {
+      /** The ad campaign's id. */
+      campaign_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_AdPayload_;
+  };
+  /**
+   * POST /ad-campaigns/{campaign_id}/retry
+   * Retry Campaign Launch
+   * tier: external · scope: ads:run
+   */
+  retry_campaign_launch_ad_campaigns__campaign_id__retry_post: {
+    input: {
+    path: {
+      /** The ad campaign's id. */
+      campaign_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_AdPayload_;
+  };
+  /**
+   * POST /ad-campaigns/{campaign_id}/ads/{ad_id}/status
+   * Set Campaign Ad Status
+   * tier: external · scope: ads:run
+   */
+  set_campaign_ad_status_ad_campaigns__campaign_id__ads__ad_id__status_post: {
+    input: {
+    path: {
+      /** Ad campaign ID */
+      campaign_id: number;
+      /** graph8 ad ID */
+      ad_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: AdStatusRequest;
+  };
+    output: ApiResponse_AdResponse_;
+  };
+  /**
+   * PUT /ad-campaigns/{campaign_id}
+   * Update Ad Campaign
+   * tier: external · scope: ads:run
+   */
+  update_ad_campaign_ad_campaigns__campaign_id__put: {
+    input: {
+    path: {
+      /** The ad campaign's id. */
+      campaign_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: UpdateAdCampaignRequest;
+  };
+    output: ApiResponse_AdPayload_;
+  };
+  /**
+   * PATCH /ad-campaigns/{campaign_id}/ads/{ad_id}
+   * Update Campaign Ad
+   * tier: external · scope: ads:run
+   */
+  update_campaign_ad_ad_campaigns__campaign_id__ads__ad_id__patch: {
+    input: {
+    path: {
+      /** Ad campaign ID */
+      campaign_id: number;
+      /** graph8 ad ID */
+      ad_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: AdUpdateRequest;
+  };
+    output: ApiResponse_AdUpdateResponse_;
+  };
+  /**
+   * POST /ad-campaigns/images
+   * Upload Ad Image
+   * tier: external · scope: ads:run
+   */
+  upload_ad_image_ad_campaigns_images_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_AdPayload_;
+  };
+}
+
+// 21 schemas referenced above (the same as G8Contract.<Name>).
+
+/**
+ * Add several ads at once — "launch these four creatives as four ads".
+ *
+ * Partial success is expected: one creative rejected on policy does not stop
+ * the others, and the response reports each outcome separately.
+ */
+export interface AdBatchCreateRequest {
+  ads: Array<AdCreateRequest>;
+}
+
+export interface AdBatchCreateResponse {
+  campaign_id: number;
+  failed: number;
+  platform?: string | null;
+  requested: number;
+  results: Array<AdBatchResultItem>;
+  /** ok | partial — never render success off a 200 alone */
+  status: string;
+  succeeded: number;
+}
+
+export interface AdBatchResultItem {
+  ad?: AdResponse | null;
+  error?: string | null;
+  index: number;
+  status: string;
+}
+
+/**
+ * A launched paid-ad campaign.
+ *
+ * Creative fields are NOT published here even though they still exist on the
+ * underlying row for backwards compatibility. They are attributes of an ad,
+ * not of a campaign, and publishing them at campaign level would force either
+ * a breaking change or a permanent duplicate representation once a campaign
+ * holds more than one ad. Read them from ``/ad-campaigns/{id}/ads``.
+ */
+export interface AdCampaignResponse {
+  /** Number of live (non-archived) ads in this campaign */
+  ad_count?: number;
+  created_at?: string | null;
+  currency?: string | null;
+  daily_budget?: number | null;
+  end_date?: string | null;
+  google_campaign_subtype?: string | null;
+  id: number;
+  launched_at?: string | null;
+  name: string;
+  objective?: string | null;
+  platform: string;
+  platform_campaign_id?: string | null;
+  start_date?: string | null;
+  status: string;
+  sync_config_id: number;
+}
+
+/**
+ * Add one ad to a campaign.
+ *
+ * Valid before launch (created with its siblings when the campaign launches)
+ * and after (pushed to the live campaign immediately). ``extra="forbid"`` so a
+ * field we never wired is a 422 rather than a silent success.
+ */
+export interface AdCreateRequest {
+  copy_assets?: Record<string, unknown> | null;
+  creative_image_url?: string | null;
+  creative_image_url_portrait?: string | null;
+  creative_image_url_square?: string | null;
+  cta?: string | null;
+  description?: string | null;
+  destination_url?: string | null;
+  headline?: string | null;
+  logo_image_url?: string | null;
+  name?: string | null;
+  primary_text?: string | null;
+  source_ad_creative_id?: string | null;
+}
+
+export interface AdListResponse {
+  ads: Array<AdResponse>;
+  campaign_id: number;
+  count: number;
+  platform?: string | null;
+}
+
+/** One ad-platform object, or one handler response. */
+export type AdPayload = Record<string, unknown>;
+
+/**
+ * One ad inside a campaign — a creative slot.
+ *
+ * ``id`` is graph8's, and it is stable: editing an ad almost always mints a new
+ * platform ad (LinkedIn creatives are immutable, and on Google only Search/RSA
+ * is mutable in place), but the slot and its measurement history survive that.
+ * Address an ad by this id, never by ``platform_ad_id``.
+ */
+export interface AdResponse {
+  approval_nuance?: string | null;
+  campaign_id: number;
+  /** Multi-asset copy, e.g. {rsa_headlines: [...], rsa_descriptions: [...]} */
+  copy_assets?: Record<string, unknown> | null;
+  created_at?: string | null;
+  creative_image_url?: string | null;
+  creative_image_url_portrait?: string | null;
+  creative_image_url_square?: string | null;
+  cta?: string | null;
+  description?: string | null;
+  destination_url?: string | null;
+  error_message?: string | null;
+  headline?: string | null;
+  /** graph8 ad id, stable across creative replacements. Null only for a campaign launched before per-ad control, until its first read. */
+  id?: number | null;
+  launched_at?: string | null;
+  logo_image_url?: string | null;
+  name?: string | null;
+  /** Current platform handle. Changes when the creative is replaced. */
+  platform_ad_id?: string | null;
+  policy_topics?: Array<Record<string, unknown>> | null;
+  primary_text?: string | null;
+  slot_index: number;
+  /** The Studio creative this ad was built from, when it came from Studio */
+  source_ad_creative_id?: string | null;
+  /** draft | launching | active | paused | archived | failed */
+  status: string;
+}
+
+/** Pause or resume one ad without touching its siblings or the campaign. */
+export interface AdStatusRequest {
+  status: "active" | "paused";
+}
+
+/**
+ * Edit one ad. Omitted fields are unchanged.
+ *
+ * On a live campaign a creative change is applied as a REPLACE, because that
+ * is what the platforms permit. The response reports whether the platform ad
+ * was replaced so a caller knows review and learning restarted.
+ */
+export interface AdUpdateRequest {
+  copy_assets?: Record<string, unknown> | null;
+  creative_image_url?: string | null;
+  creative_image_url_portrait?: string | null;
+  creative_image_url_square?: string | null;
+  cta?: string | null;
+  description?: string | null;
+  destination_url?: string | null;
+  headline?: string | null;
+  logo_image_url?: string | null;
+  name?: string | null;
+  primary_text?: string | null;
+  source_ad_creative_id?: string | null;
+}
+
+export interface AdUpdateResponse {
+  ad: AdResponse;
+  changed: Array<string>;
+  /** policy_review | learning_reset */
+  consequences?: Array<string>;
+  /** True when the platform ad was recreated; review and learning restart */
+  replaced_platform_ad: boolean;
+}
+
+export interface ApiResponse_AdBatchCreateResponse_ {
+  data: AdBatchCreateResponse;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_AdCampaignResponse_ {
+  data: AdCampaignResponse;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_AdListResponse_ {
+  data: AdListResponse;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_AdPayload_ {
+  data: AdPayload;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_AdResponse_ {
+  data: AdResponse;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_AdUpdateResponse_ {
+  data: AdUpdateResponse;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_list_AdCampaignResponse__ {
+  data: Array<AdCampaignResponse>;
+  pagination?: PaginationMeta | null;
+}
+
+export interface LaunchAdCampaignRequest {
+  ad_copy_variant_index?: number | null;
+  ad_image_document_id?: number | null;
+  /** Absolute UTC instant to auto-pause at (ISO-8601 with offset) */
+  auto_pause_at?: string | null;
+  /** IANA zone the user picked in (display/intent only) */
+  auto_pause_tz?: string | null;
+  creative_image_url?: string | null;
+  creative_image_url_portrait?: string | null;
+  creative_image_url_square?: string | null;
+  cta?: string | null;
+  currency?: string;
+  /** Demand Gen only: intent keywords for a custom segment (people who search these) */
+  custom_segment_keywords?: Array<string> | null;
+  /** Demand Gen only: competitor/relevant URLs for a custom segment (people who browse these) */
+  custom_segment_urls?: Array<string> | null;
+  /** Google Customer Match mode: observation (default) | targeting | exclusion */
+  customer_match_mode?: string | null;
+  daily_budget?: number;
+  destination_url?: string | null;
+  end_date?: string | null;
+  /** ISO 3166-1 alpha-2 country code for the location criterion (Google observation/exclusion modes) */
+  geo_target_country?: string | null;
+  /** Google campaign subtype: display (default) | demand_gen | search */
+  google_campaign_subtype?: string | null;
+  headline?: string | null;
+  /** Demand Gen only: attach the lookalike segment derived from the Customer Match list */
+  include_lookalike_audiences?: boolean | null;
+  logo_image_url?: string | null;
+  /** User-provided campaign name; auto-generated if empty */
+  name?: string | null;
+  objective?: string;
+  primary_text?: string | null;
+  /** Google Search only: 2-4 Responsive Search Ad descriptions (≤90 chars each) */
+  rsa_descriptions?: Array<string> | null;
+  /** Google Search only: 3-15 Responsive Search Ad headlines (≤30 chars each) */
+  rsa_headlines?: Array<string> | null;
+  /** Google Search only: [{text, match_type: broad|phrase|exact, negative: bool}] */
+  search_keywords?: Array<Record<string, unknown>> | null;
+  /** Google Video only: placement switches — youtube_in_stream | youtube_in_feed | youtube_shorts | discover | gmail | display | maps (true/false) */
+  selected_channels?: Record<string, boolean> | null;
+  /** Meta special ad categories: HOUSING | EMPLOYMENT | CREDIT | FINANCIAL_PRODUCTS_SERVICES | ISSUES_ELECTIONS_POLITICS | ONLINE_GAMBLING_AND_GAMING | NONE */
+  special_ad_categories?: Array<string> | null;
+  /** Auto-pause once lifetime SERVED spend reaches this (account currency) */
+  spend_cap?: number | null;
+  start_date?: string;
+  /** Google Video only: 1-5 ids of the org's ad_video_assets rows to advertise */
+  video_asset_ids?: Array<number> | null;
+  /** Google Video only: advertiser/brand name shown on the ad (≤25 chars) */
+  video_business_name?: string | null;
+  /** Google Video only: CallToActionType enum value (e.g. LEARN_MORE, SIGN_UP) */
+  video_cta?: string | null;
+  /** Google Video only: 3-5 descriptions (≤90 chars each) */
+  video_descriptions?: Array<string> | null;
+  /** Google Video only: 3-5 headlines (≤40 chars each) */
+  video_headlines?: Array<string> | null;
+  /** Google Video only: 3-5 long headlines (≤90 chars each) */
+  video_long_headlines?: Array<string> | null;
+}
+
+export interface PaginationMeta {
+  /** Whether there are more pages */
+  has_next: boolean;
+  /** Items per page */
+  limit: number;
+  /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
+  next_cursor?: string | null;
+  /** Current page number (1-indexed) */
+  page: number;
+  /** Total number of items */
+  total: number;
+}
+
+/**
+ * Body for ``PUT /campaigns/{id}`` and ``POST /campaigns/{id}/edit-preview``.
+ *
+ * ``extra="forbid"`` is load-bearing (PRD hazard H8): the model used to inherit
+ * Pydantic's default ``extra="ignore"``, so the wizard could POST a field the
+ * backend had never wired, get a 200, and render a green "Campaign updated"
+ * toast for an edit that reached nothing. An unknown field is now a 422 —
+ * a phantom control is structurally impossible to ship.
+ *
+ * List-shaped fields (``keywords``, ``rsa_headlines``, ``rsa_descriptions``,
+ * ``geo_targets``) are COMPLETE desired lists, never deltas. Google replaces
+ * repeated fields wholesale, so a partial list silently deletes the omitted
+ * entries; the handler read-modify-writes against the platform's current state.
+ * ``None`` means "not provided / unchanged" — an empty list is a real request
+ * to clear, and is rejected where clearing would break the ad.
+ */
+export interface UpdateAdCampaignRequest {
+  action?: string | null;
+  /** Absolute UTC instant to auto-pause at (ISO-8601 with offset) */
+  auto_pause_at?: string | null;
+  auto_pause_tz?: string | null;
+  /** Google only: COMPLETE desired campaign-level negative keywords [{text, match_type}] */
+  campaign_negative_keywords?: Array<Record<string, unknown>> | null;
+  clear_auto_stop?: boolean;
+  creative_image_url?: string | null;
+  creative_image_url_portrait?: string | null;
+  creative_image_url_square?: string | null;
+  cta?: string | null;
+  daily_budget?: number | null;
+  destination_url?: string | null;
+  end_date?: string | null;
+  /** Google only: COMPLETE list of geo target constant ids, e.g. ["2840"] */
+  geo_targets?: Array<string> | null;
+  headline?: string | null;
+  /** Google Search only: COMPLETE desired keyword list [{text, match_type, negative, paused, cpc_bid}] */
+  keywords?: Array<Record<string, unknown>> | null;
+  logo_image_url?: string | null;
+  name?: string | null;
+  primary_text?: string | null;
+  /** Google Search only: COMPLETE list of 2-4 RSA descriptions (<=90 chars each) */
+  rsa_descriptions?: Array<string> | null;
+  /** Google Search only: COMPLETE list of 3-15 RSA headlines (<=30 chars each) */
+  rsa_headlines?: Array<string> | null;
+  /** Google Video only: COMPLETE placement map (7 DemandGenSelectedChannels keys) */
+  selected_channels?: Record<string, boolean> | null;
+  spend_cap?: number | null;
+  /** Google Video only: COMPLETE list of 1-5 ad_video_assets ids (None = unchanged) */
+  video_asset_ids?: Array<number> | null;
+  /** Google Video only: ≤25 chars */
+  video_business_name?: string | null;
+  /** Google Video only: CallToActionType value */
+  video_cta?: string | null;
+  /** Google Video only: COMPLETE list, 3-5 × ≤90 */
+  video_descriptions?: Array<string> | null;
+  /** Google Video only: COMPLETE list, 3-5 × ≤40 */
+  video_headlines?: Array<string> | null;
+  /** Google Video only: COMPLETE list, 3-5 × ≤90 */
+  video_long_headlines?: Array<string> | null;
+}