# DCM/DFA Reporting And Trafficking API . projects

## Instance Methods

Gets one project by ID.

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

Retrieves the next page of results.

### Method Details

`get(profileId, id)`

    Gets one project by ID.

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

    Returns:
      An object of the form:

        { # Contains properties of a Planning project.
        "accountId": "A String", # Account ID of this project.
        "advertiserId": "A String", # Advertiser ID of this project.
        "audienceAgeGroup": "A String", # Audience age group of this project.
        "audienceGender": "A String", # Audience gender of this project.
        "budget": "A String", # Budget of this project in the currency specified by the current account. The value stored in this field represents only the non-fractional amount. For example, for USD, the smallest value that can be represented by this field is 1 US dollar.
        "clientBillingCode": "A String", # Client billing code of this project.
        "clientName": "A String", # Name of the project client.
        "endDate": "A String", # End date of the project.
        "id": "A String", # ID of this project. This is a read-only, auto-generated field.
        "kind": "dfareporting#project", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#project".
        "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this project.
          "time": "A String", # Timestamp of the last change in milliseconds since epoch.
        },
        "name": "A String", # Name of this project.
        "overview": "A String", # Overview of this project.
        "startDate": "A String", # Start date of the project.
        "subaccountId": "A String", # Subaccount ID of this project.
        "targetClicks": "A String", # Number of clicks that the advertiser is targeting.
        "targetConversions": "A String", # Number of conversions that the advertiser is targeting.
        "targetCpaNanos": "A String", # CPA that the advertiser is targeting.
        "targetCpcNanos": "A String", # CPC that the advertiser is targeting.
        "targetCpmActiveViewNanos": "A String", # vCPM from Active View that the advertiser is targeting.
        "targetCpmNanos": "A String", # CPM that the advertiser is targeting.
        "targetImpressions": "A String", # Number of impressions that the advertiser is targeting.
      }

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

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

    Args:
      profileId: string, User profile ID associated with this request. (required)
      advertiserIds: string, Select only projects with these advertiser IDs. (repeated)
      ids: string, Select only projects 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 projects by name or ID. Wildcards (*) are allowed. For example, "project*2015" will return projects with names like "project June 2015", "project April 2015", or simply "project 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 "project" will match projects with name "my project", "project 2015", or simply "project".
      sortField: string, Field by which to sort the list.
        Allowed values
          ID -
          NAME -
      sortOrder: string, Order of sorted results.
        Allowed values
          ASCENDING -
          DESCENDING -

    Returns:
      An object of the form:

        { # Project List Response
        "kind": "dfareporting#projectsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#projectsListResponse".
        "nextPageToken": "A String", # Pagination token to be used for the next list operation.
        "projects": [ # Project collection.
          { # Contains properties of a Planning project.
            "accountId": "A String", # Account ID of this project.
            "advertiserId": "A String", # Advertiser ID of this project.
            "audienceAgeGroup": "A String", # Audience age group of this project.
            "audienceGender": "A String", # Audience gender of this project.
            "budget": "A String", # Budget of this project in the currency specified by the current account. The value stored in this field represents only the non-fractional amount. For example, for USD, the smallest value that can be represented by this field is 1 US dollar.
            "clientBillingCode": "A String", # Client billing code of this project.
            "clientName": "A String", # Name of the project client.
            "endDate": "A String", # End date of the project.
            "id": "A String", # ID of this project. This is a read-only, auto-generated field.
            "kind": "dfareporting#project", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#project".
            "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this project.
              "time": "A String", # Timestamp of the last change in milliseconds since epoch.
            },
            "name": "A String", # Name of this project.
            "overview": "A String", # Overview of this project.
            "startDate": "A String", # Start date of the project.
            "subaccountId": "A String", # Subaccount ID of this project.
            "targetClicks": "A String", # Number of clicks that the advertiser is targeting.
            "targetConversions": "A String", # Number of conversions that the advertiser is targeting.
            "targetCpaNanos": "A String", # CPA that the advertiser is targeting.
            "targetCpcNanos": "A String", # CPC that the advertiser is targeting.
            "targetCpmActiveViewNanos": "A String", # vCPM from Active View that the advertiser is targeting.
            "targetCpmNanos": "A String", # CPM that the advertiser is targeting.
            "targetImpressions": "A String", # Number of impressions that the advertiser is targeting.
          },
        ],
      }

`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.