DCM/DFA Reporting And Trafficking API . 4 . placementStrategies

Instance Methods

delete(profileId=*, id=*)

Deletes an existing placement strategy.

get(profileId=*, id=*)

Gets one placement strategy by ID.

insert(profileId=*, body=None)

Inserts a new placement strategy.

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

Retrieves a list of placement strategies, possibly filtered. This method supports paging.

list_next(previous_request=*, previous_response=*)

Retrieves the next page of results.

patch(profileId=*, id=*, body=None)

Updates an existing placement strategy. This method supports patch semantics.

update(profileId=*, body=None)

Updates an existing placement strategy.

Method Details

delete(profileId=*, id=*)
Deletes an existing placement strategy.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Placement strategy ID. (required)
get(profileId=*, id=*)
Gets one placement strategy by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Placement strategy ID. (required)

Returns:
  An object of the form:

    { # Contains properties of a placement strategy.
      "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
      "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
      "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
      "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
    }
insert(profileId=*, body=None)
Inserts a new placement strategy.

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 placement strategy.
    "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
    "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
    "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
    "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a placement strategy.
      "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
      "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
      "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
      "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
    }
list(profileId=*, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)
Retrieves a list of placement strategies, possibly filtered. This method supports paging.

Args:
  profileId: string, User profile ID associated with this request. (required)
  searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "placementstrategy*2015" will return objects with names like "placementstrategy June 2015", "placementstrategy April 2015", or simply "placementstrategy 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementstrategy" will match objects with name "my placementstrategy", "placementstrategy 2015", or simply "placementstrategy".
  pageToken: string, Value of the nextPageToken from the previous result page.
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  ids: string, Select only placement strategies with these IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  sortOrder: string, Order of sorted results.
    Allowed values
      ASCENDING - 
      DESCENDING - 

Returns:
  An object of the form:

    { # Placement Strategy List Response
    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    "kind": "dfareporting#placementStrategiesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategiesListResponse".
    "placementStrategies": [ # Placement strategy collection.
      { # Contains properties of a placement strategy.
          "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
          "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
          "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
          "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
        },
    ],
  }
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=*, id=*, body=None)
Updates an existing placement strategy. This method supports patch semantics.

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

{ # Contains properties of a placement strategy.
    "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
    "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
    "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
    "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a placement strategy.
      "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
      "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
      "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
      "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
    }
update(profileId=*, body=None)
Updates an existing placement strategy.

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 placement strategy.
    "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
    "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
    "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
    "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
  }


Returns:
  An object of the form:

    { # Contains properties of a placement strategy.
      "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
      "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
      "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
      "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
    }