Campaign Manager 360 API . creativeFieldValues

close()

Close httplib2 connections.

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

Deletes an existing creative field value.

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

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

Gets one creative field value by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  creativeFieldId: string, Creative field ID for this creative field value. (required)
  id: string, Creative Field Value 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 value.
  "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
  "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
}

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

Inserts a new creative field value.

Args:
  profileId: string, User profile ID associated with this request. (required)
  creativeFieldId: string, Creative field ID for this creative field value. (required)
  body: object, The request body.
    The object takes the form of:

{ # Contains properties of a creative field value.
  "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
  "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
}

  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 value.
  "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
  "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
}

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

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

Args:
  profileId: string, User profile ID associated with this request. (required)
  creativeFieldId: string, Creative field ID for this creative field value. (required)
  ids: string, Select only creative field values 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 field values by their values. Wildcards (e.g. *) are not allowed.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      VALUE - 
  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 Value List Response
  "creativeFieldValues": [ # Creative field value collection.
    { # Contains properties of a creative field value.
      "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
      "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
      "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
    },
  ],
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValuesListResponse".
  "nextPageToken": "A String", # Pagination token to be used for the next list operation.
}

list_next(previous_request, previous_response)

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, creativeFieldId, id, body=None, x__xgafv=None)

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

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

{ # Contains properties of a creative field value.
  "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
  "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
}

  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 value.
  "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
  "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
}

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

Updates an existing creative field value.

Args:
  profileId: string, User profile ID associated with this request. (required)
  creativeFieldId: string, Creative field ID for this creative field value. (required)
  body: object, The request body.
    The object takes the form of:

{ # Contains properties of a creative field value.
  "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
  "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
}

  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 value.
  "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
  "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
}