# Campaign Manager 360 API . creativeFields

## Instance Methods

Close httplib2 connections.

Deletes an existing creative field.

Gets one creative field by ID.

Inserts a new creative field.

Retrieves a list of creative fields, possibly filtered. This method supports paging.

Retrieves the next page of results.

Updates an existing creative field. This method supports patch semantics.

Updates an existing creative field.

### Method Details

`close()`

    Close httplib2 connections.

`delete(profileId, id, x__xgafv=None)`

    Deletes an existing creative field.

    Args:
      profileId: string, User profile ID associated with this request. (required)
      id: string, Creative Field ID (required)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

`get(profileId, id, x__xgafv=None)`

    Gets one creative field by ID.

    Args:
      profileId: string, User profile ID associated with this request. (required)
      id: string, Creative Field ID (required)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Contains properties of a creative field.
      "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
      "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "dimensionName": "A String", # The name of the dimension.
        "etag": "A String", # The eTag of this response for caching purposes.
        "id": "A String", # The ID associated with the value if available.
        "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
        "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
        "value": "A String", # The value of the dimension.
      },
      "id": "A String", # ID of this creative field. This is a read-only, auto-generated field.
      "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
      "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
      "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
    }

`insert(profileId, body=None, x__xgafv=None)`

    Inserts a new creative field.

    Args:
      profileId: string, User profile ID associated with this request. (required)
      body: object, The request body.
        The object takes the form of:

    { # Contains properties of a creative field.
      "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
      "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "dimensionName": "A String", # The name of the dimension.
        "etag": "A String", # The eTag of this response for caching purposes.
        "id": "A String", # The ID associated with the value if available.
        "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
        "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
        "value": "A String", # The value of the dimension.
      },
      "id": "A String", # ID of this creative field. This is a read-only, auto-generated field.
      "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
      "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
      "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
    }

      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Contains properties of a creative field.
      "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
      "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "dimensionName": "A String", # The name of the dimension.
        "etag": "A String", # The eTag of this response for caching purposes.
        "id": "A String", # The ID associated with the value if available.
        "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
        "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
        "value": "A String", # The value of the dimension.
      },
      "id": "A String", # ID of this creative field. This is a read-only, auto-generated field.
      "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
      "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
      "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
    }

`list(profileId, advertiserIds=None, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, x__xgafv=None)`

    Retrieves a list of creative fields, possibly filtered. This method supports paging.

    Args:
      profileId: string, User profile ID associated with this request. (required)
      advertiserIds: string, Select only creative fields that belong to these advertisers. (repeated)
      ids: string, Select only creative fields with these IDs. (repeated)
      maxResults: integer, Maximum number of results to return.
      pageToken: string, Value of the nextPageToken from the previous result page.
      searchString: string, Allows searching for creative fields by name or ID. Wildcards (*) are allowed. For example, "creativefield*2015" will return creative fields with names like "creativefield June 2015", "creativefield April 2015", or simply "creativefield 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativefield" will match creative fields with the name "my creativefield", "creativefield 2015", or simply "creativefield".
      sortField: string, Field by which to sort the list.
        Allowed values
          ID -
          NAME -
      sortOrder: string, Order of sorted results.
        Allowed values
          ASCENDING -
          DESCENDING -
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Creative Field List Response
      "creativeFields": [ # Creative field collection.
        { # Contains properties of a creative field.
          "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
          "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
            "dimensionName": "A String", # The name of the dimension.
            "etag": "A String", # The eTag of this response for caching purposes.
            "id": "A String", # The ID associated with the value if available.
            "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
            "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
            "value": "A String", # The value of the dimension.
          },
          "id": "A String", # ID of this creative field. This is a read-only, auto-generated field.
          "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
          "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
          "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
        },
      ],
      "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldsListResponse".
      "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    }

`list_next()`

    Retrieves the next page of results.

            Args:
              previous_request: The request for the previous page. (required)
              previous_response: The response from the request for the previous page. (required)

            Returns:
              A request object that you can call 'execute()' on to request the next
              page. Returns None if there are no more items in the collection.

`patch(profileId, id, body=None, x__xgafv=None)`

    Updates an existing creative field. This method supports patch semantics.

    Args:
      profileId: string, User profile ID associated with this request. (required)
      id: string, CreativeField ID. (required)
      body: object, The request body.
        The object takes the form of:

    { # Contains properties of a creative field.
      "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
      "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "dimensionName": "A String", # The name of the dimension.
        "etag": "A String", # The eTag of this response for caching purposes.
        "id": "A String", # The ID associated with the value if available.
        "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
        "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
        "value": "A String", # The value of the dimension.
      },
      "id": "A String", # ID of this creative field. This is a read-only, auto-generated field.
      "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
      "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
      "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
    }

      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Contains properties of a creative field.
      "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
      "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "dimensionName": "A String", # The name of the dimension.
        "etag": "A String", # The eTag of this response for caching purposes.
        "id": "A String", # The ID associated with the value if available.
        "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
        "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
        "value": "A String", # The value of the dimension.
      },
      "id": "A String", # ID of this creative field. This is a read-only, auto-generated field.
      "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
      "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
      "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
    }

`update(profileId, body=None, x__xgafv=None)`

    Updates an existing creative field.

    Args:
      profileId: string, User profile ID associated with this request. (required)
      body: object, The request body.
        The object takes the form of:

    { # Contains properties of a creative field.
      "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
      "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "dimensionName": "A String", # The name of the dimension.
        "etag": "A String", # The eTag of this response for caching purposes.
        "id": "A String", # The ID associated with the value if available.
        "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
        "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
        "value": "A String", # The value of the dimension.
      },
      "id": "A String", # ID of this creative field. This is a read-only, auto-generated field.
      "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
      "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
      "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
    }

      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Contains properties of a creative field.
      "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
      "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        "dimensionName": "A String", # The name of the dimension.
        "etag": "A String", # The eTag of this response for caching purposes.
        "id": "A String", # The ID associated with the value if available.
        "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
        "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
        "value": "A String", # The value of the dimension.
      },
      "id": "A String", # ID of this creative field. This is a read-only, auto-generated field.
      "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
      "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
      "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
    }