get(resourceName, x__xgafv=None)

Returns the requested custom column in full detail.

Args:
  resourceName: string, Required. The resource name of the custom column to fetch. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A custom column. See Search Ads 360 custom column at https://support.google.com/sa360/answer/9633916
  "description": "A String", # Output only. User-defined description of the custom column.
  "id": "A String", # Output only. ID of the custom column.
  "name": "A String", # Output only. User-defined name of the custom column.
  "queryable": True or False, # Output only. True when the custom column is available to be used in the query of SearchAds360Service.Search and SearchAds360Service.SearchStream.
  "referencedSystemColumns": [ # Output only. The list of the referenced system columns of this custom column. For example, A custom column "sum of impressions and clicks" has referenced system columns of {"metrics.clicks", "metrics.impressions"}.
    "A String",
  ],
  "referencesAttributes": True or False, # Output only. True when the custom column is referring to one or more attributes.
  "referencesMetrics": True or False, # Output only. True when the custom column is referring to one or more metrics.
  "renderType": "A String", # Output only. How the result value of the custom column should be interpreted.
  "resourceName": "A String", # Immutable. The resource name of the custom column. Custom column resource names have the form: `customers/{customer_id}/customColumns/{custom_column_id}`
  "valueType": "A String", # Output only. The type of the result value of the custom column.
}

list(customerId, x__xgafv=None)

Returns all the custom columns associated with the customer in full detail.

Args:
  customerId: string, Required. The ID of the customer to apply the CustomColumn list operation to. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for fetching all custom columns associated with a customer.
  "customColumns": [ # The CustomColumns owned by the provided customer.
    { # A custom column. See Search Ads 360 custom column at https://support.google.com/sa360/answer/9633916
      "description": "A String", # Output only. User-defined description of the custom column.
      "id": "A String", # Output only. ID of the custom column.
      "name": "A String", # Output only. User-defined name of the custom column.
      "queryable": True or False, # Output only. True when the custom column is available to be used in the query of SearchAds360Service.Search and SearchAds360Service.SearchStream.
      "referencedSystemColumns": [ # Output only. The list of the referenced system columns of this custom column. For example, A custom column "sum of impressions and clicks" has referenced system columns of {"metrics.clicks", "metrics.impressions"}.
        "A String",
      ],
      "referencesAttributes": True or False, # Output only. True when the custom column is referring to one or more attributes.
      "referencesMetrics": True or False, # Output only. True when the custom column is referring to one or more metrics.
      "renderType": "A String", # Output only. How the result value of the custom column should be interpreted.
      "resourceName": "A String", # Immutable. The resource name of the custom column. Custom column resource names have the form: `customers/{customer_id}/customColumns/{custom_column_id}`
      "valueType": "A String", # Output only. The type of the result value of the custom column.
    },
  ],
}

Search Ads 360 Reporting API . customers . customColumns

Instance Methods

Method Details